Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-07-13 06:20:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update troubleshooting.md

Browse Source
This commit is contained in:
AnomicDev 2024-04-14 00:52:07 +00:00
parent 87ef0f21a3
commit cd738137c0
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/maintenance/troubleshooting.md
View File

@ -33,6 +33,35 @@ Press Control+C once.
Now start the worker again with `supervisorctl start myauth:worker`
## Steps to Check Logs for Errors
### Locate the Logs:
The logs are located within the `myauth/log/` directory of your Alliance Auth project.
### Access the Logs:
Use a text editor or terminal commands (like `tail -f <filename>`) to open the relevant log files.
_(The tail -f command displays the last few lines of a file and then continues to monitor the file, printing any new lines that are added in real-time. Useful to watch while actively testing a troublesome feature for debugging.)
Consider the following:
`allianceauth.log` is the primary log for general troubleshooting.
`worker.log` is important for issues related to background tasks.(Such as services(Discord)).
`beat.log` if you suspect scheduler problems.
`gunicorn.log` for web-specific or Gunicorn worker 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.
Troubleshooting Tips
**Filter Logs:** Use tools like `grep` to filter logs based on keywords or timeframes, making it easier to focus on relevant information.
**_Example_**: `tail -f allianceauth.log | grep -i 'discord'`. This will isolate lines containing discord. Making it easier to see amoung the other logs.
**Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your Alliance Auth settings to get more detailed messages. Remember to revert to INFO level after debugging.
**Important Note: Before sharing logs publicly, sanitize any sensitive information such as usernames, passwords, or API keys.**
### Proxy timeout when entering email address
This usually indicates an issue with your email settings. Ensure these are correct and your email server/service is properly configured.