diff --git a/docs/maintenance/troubleshooting.md b/docs/maintenance/troubleshooting.md index 2b0a6e2c..4f3b7eee 100644 --- a/docs/maintenance/troubleshooting.md +++ b/docs/maintenance/troubleshooting.md @@ -8,11 +8,11 @@ To record DEBUG messages in the log file, alter a setting in your auth project's ## Steps to Check Logs for Errors -### Locate the Logs: +### Locate the Logs The logs are located within the `myauth/log/` directory of your Alliance Auth project. -### Access the Logs: +### Access the Logs Use a text editor or terminal commands (like `tail -f `) to open the relevant log files. @@ -28,7 +28,7 @@ Consider the following: `gunicorn.log` for web-specific or Gunicorn worker errors. -### Search for Errors: +### Search for Errors Look for keywords like `ERROR`, `WARNING`, `EXCEPTION`, or `CRITICAL`. Examine timestamps to correlate errors with user actions or events. Read the error messages carefully for clues about the problem's nature. @@ -46,7 +46,7 @@ Troubleshooting Tips: ### I'm getting error 500 when trying to connect to the website on a new installation -*Great.* Error 500 is the generic message given by your web server when *anything* breaks. The actual error message is hidden in one of your auth project's log files. Read them to identify it. +_Great._ Error 500 is the generic message given by your web server when _anything_ breaks. The actual error message is hidden in one of your auth project's log files. Read them to identify it. ### Failed to configure log handler