Minor Documentation Update (#1019)

Gunicorn needs to be run whilist in the folder for context, folder path is not enough
Correct static path, note to check nginx user
Capitalization of services and small typos
Service examples updated to their latest versions and download links
Expanded /var/www chowns for Nginx and Apache examples
Add in a troubleshooting note for no images being displayed (permissions issue) and gunicorn not execting (file path context)
Correct formatting. Reword a few parts. Remove "new in 1.15".
This commit is contained in:
Ariel Rin
2018-04-18 08:55:18 +10:00
committed by Adarnof
parent cd8bcfbbb5
commit 95f72c854d
27 changed files with 203 additions and 181 deletions

View File

@@ -8,15 +8,15 @@ When installing Alliance Auth you are instructed to run the `allianceauth start`
The first folder created is the root directory of your auth project. This folder contains:
- the `manage.py` management script used to interact with Django
- a preconfigured `supervisor.conf` supervisor config for running celery (and optionally gunicorn) automatically
- a preconfigured `supervisor.conf` Supervisor config for running Celery (and optionally Gunicorn) automatically
- a `log` folder which contains log files generated by Alliance Auth
### The myauth Subfolder
Within your auth project root folder is another folder of the same name (a quirk of django project structures). This folder contains:
- a celery app definition in `celery.py` for registering tasks with the background workers
Within your auth project root folder is another folder of the same name (a quirk of Django project structures). This folder contains:
- a Celery app definition in `celery.py` for registering tasks with the background workers
- a web server gateway interface script `wsgi.py` for processing web requests
- the root url config `urls.py` which Django uses to direct requests to the appropriate view
- the root URL config `urls.py` which Django uses to direct requests to the appropriate view
There are also two subfolders for `static` and `templates` which allow adding new content and overriding default content shipped with Alliance Auth or Django.
@@ -35,15 +35,15 @@ The local settings file is referred to as "your auth project's settings file" an
Your auth project comes with four log file definitions by default. These are created in the `myauth/log/` folder at runtime.
- `allianceauth.log` contains all `INFO` level and above logging messages from Alliance Auth. This is useful for tracking who is making changes to the site, what is happening to users, and debugging any errors that may occur.
- `worker.log` contains logging messages from the celery background task workers. This is useful for monitoring background processes such as group syncing to services.
- `worker.log` contains logging messages from the Celery background task workers. This is useful for monitoring background processes such as group syncing to services.
- `beat.log` contains logging messages from the background task scheduler. This is of limited use unless the scheduler isn't starting.
- `gunicorn.log` contains logging messages from gunicorn workers. This contains all web-sourced messages found in `allianceauth.log` as well as runtime errors from the workers themselves.
- `gunicorn.log` contains logging messages from Gunicorn workers. This contains all web-sourced messages found in `allianceauth.log` as well as runtime errors from the workers themselves.
When asking for assistance with your auth project be sure to first read the logs, and share any relevant entries.
## Custom Static and Templates
Within your auth project exists two folders named `static` and `templates`. These are used by Django for rendering web pages. Static refers to content Django does not need to parse before displaying, such as CSS styling or images. When running via a WSGI worker such as gunicorn static files are copied to a location for the web server to read from. Templates are always read from the template folders, rendered with additional context from a view function, and then displayed to the user.
Within your auth project exists two folders named `static` and `templates`. These are used by Django for rendering web pages. Static refers to content Django does not need to parse before displaying, such as CSS styling or images. When running via a WSGI worker such as Gunicorn static files are copied to a location for the web server to read from. Templates are always read from the template folders, rendered with additional context from a view function, and then displayed to the user.
You can add extra static or templates by putting files in these folders. Note that changes to static requires running the `python manage.py collectstatic` command to copy to the web server directory.

View File

@@ -20,7 +20,7 @@ It's probably a permissions issue. Ensure your current user can write to the vir
### Failed to configure log handler
Make sure the log directory is write-able by the allianceserver user: `chmown -R allianceserver:allianceserver /path/to/myauth/log/`, then restart the auth supervisor processes.
Make sure the log directory is writeable by the allianceserver user: `chmown -R allianceserver:allianceserver /path/to/myauth/log/`, then restart the auth supervisor processes.
### Groups aren't syncing to services
@@ -40,3 +40,11 @@ Now start the worker again with `supervisorctl start myauth:worker`
### 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.
### No images are available to users accessing the website
This is due to a permissions mismatch, check the setup guide for your web server. Additionally ensure the user who owns /var/www/myauth/static is the same user as running your webserver, as this can be non-standard.
### Unable to execute 'gunicorn myauth.wsgi' or ImportError: No module named 'myauth.wsgi'
Gunicorn needs to have context for its running location, `/home/alllianceserver/myauth/gunicorn myauth.wsgi` will not work, instead `cd /home/alllianceserver/myauth` then `gunicorn myauth.wsgi` is needed to boot Gunicorn. This is handled in the Supervisor config, but this may be encountered running Gunicorn manually for testing.