Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-12-18 23:05:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'v4.x' of gitlab.com:allianceauth/allianceauth into v4docs

Browse Source
This commit is contained in:
Ariel Rin
2024-02-23 22:26:38 +10:00
parent 677c46c48a 1c7f8256d0
commit 445683c3d5
173 changed files with 5993 additions and 2913 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/installation/allianceauth.md
View File

@@ -24,7 +24,7 @@ To install on your favorite flavour of Linux, identify and install equivalent pa
### OS Maintenance
It is recommended to ensure your OS is fully up to date before proceeding. We may also add Package Repositories here, used later in the documentation.
It is recommended to ensure your OS is fully up-to-date before proceeding. We may also add Package Repositories here, used later in the documentation.
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204
@@ -281,7 +281,7 @@ For security and permissions, it’s highly recommended you create a separate us
:::{group-tab} Ubuntu 2004, 2204
```shell
sudo useradd -s /bin/bash allianceserver
sudo adduser --disabled-login allianceserver
```
:::
@@ -319,7 +319,7 @@ sudo chown -R allianceserver:allianceserver /var/www/myauth/static/
```
:::{warning}
When installing and performing maintenance on Alliance Auth, virtual environments and python packages, _sudo_ means _superuser_ _do_, this will not use your venv or your allianceserver user and will routinely break your permission structure.
When installing and performing maintenance on Alliance Auth, virtual environments and python packages, _sudo_ means _superuser_ _do_, this will not use your venv or your allianceserver user and will routinely break your permission structure.
Only use sudo for _system_ management or if you are unsure, when explicitly instructed to do so.
@@ -337,7 +337,7 @@ Switch to the allianceserver user.
sudo su allianceserver
```
And switch to it's home directory:
And switch to its home directory:
```shell
cd ~
@@ -371,14 +371,14 @@ Each time you come to do maintenance on your Alliance Auth installation, you sho
You need to have a dedicated Eve SSO app for Alliance auth. Please go to [EVE Developer](https://developers.eveonline.com/applications) to create one.
For **scopes** your SSO app needs to have at least `publicData`. Additional scopes depends on which Alliance Auth apps you will be using. For convenience, we recommend adding all available ESO scopes to your SSO app. Note that Alliance Auth will always ask the users to approve specific scopes before they are used.
For **scopes** your SSO app needs to have at least `publicData`. Additional scopes depend on which Alliance Auth apps you will be using. For convenience, we recommend adding all available ESO scopes to your SSO app. Note that Alliance Auth will always ask the users to approve specific scopes before they are used.
As **callback URL** you want to define the URL of your Alliance Auth site plus the route: `/sso/callback`. Example for a valid callback URL: `https://auth.example.com/sso/callback`
### Alliance Auth Project
:::{warning}
Before installing any Python packages please double-check that you have activated in the virtual environment. This is usually indicated by your command line in the terminal starting with: `(auth)`.
Before installing any Python packages, please double-check that you have activated in the virtual environment. This is usually indicated by your command line in the terminal starting with: `(auth)`.
:::
#### Install Python packages
@@ -395,7 +395,7 @@ You can install **Alliance Auth** with the following command. This will install
pip install allianceauth superlance gunicorn
```
#### Create Alliance Auth project
#### Create the Alliance Auth project
Now you need to create the Django project that will run **Alliance Auth**. Ensure you are in the allianceserver home directory by issuing:
@@ -427,7 +427,7 @@ nano myauth/myauth/settings/local.py
#### Install database & static files
Django needs to setup the database before it can start.
Django needs to set up the database before it can start.
```shell
python /home/allianceserver/myauth/manage.py migrate
@@ -462,9 +462,9 @@ Before using your auth site, it is essential to create a superuser account. This
python /home/allianceserver/myauth/manage.py createsuperuser
```
Once your install is complete, the superuser account is accessed by logging in via the admin site at `https://example.com/admin`.
Once your installation is complete, the superuser account is accessed by logging in via the admin site at `https://example.com/admin`.
If you intend to use this account as your personal auth account you need to add a main character. Navigate to the normal user dashboard (at `https://example.com`) after logging in via the admin site and select `Change Main`. Once a main character has been added, it is possible to use SSO to login to this account.
If you intend to use this account as your personal auth account, you need to add a main character. Navigate to the normal user dashboard (at `https://example.com`) after logging in via the admin site and select `Change Main`. Once a main character has been added, it is possible to use SSO to log in to this account.
## Services
@@ -472,7 +472,9 @@ Alliance Auth needs some additional services to run, which we will set up and co
### Gunicorn
To run the **Alliance Auth** website a [WSGI Server](https://www.fullstackpython.com/wsgi-servers.html) is required. For this [Gunicorn](http://gunicorn.org/) is highly recommended for its ease of configuring. It can be manually run from within your `myauth` base directory with `gunicorn --bind 0.0.0.0 myauth.wsgi` or automatically run using Supervisor.
To run the **Alliance Auth** website, a [WSGI Server](https://www.fullstackpython.com/wsgi-servers.html) is required. For this [Gunicorn](http://gunicorn.org/) is highly recommended for its ease of configuring. It can be manually run from within your `myauth` base directory with `gunicorn --bind 0.0.0.0 myauth.wsgi` or automatically run using Supervisor.
If you don't see any errors, this means that Gunicorn is running fine. You can stop it with `Ctrl+C` now.
The default configuration is good enough for most installations. Additional information is available in the [gunicorn](gunicorn.md) doc.
@@ -583,7 +585,7 @@ Activate it with `sudo supervisorctl reload`.
You can check the status of the processes with `sudo supervisorctl status`. Logs from these processes are available in `/home/allianceserver/myauth/log` named by process.
:::{note}
Any time the code or your settings change you'll need to restart Gunicorn and Celery. ::
Any time the code or your settings change, you'll need to restart Gunicorn and Celery. ::
```shell
sudo supervisorctl restart myauth:
@@ -595,13 +597,13 @@ sudo supervisorctl restart myauth:
Once installed, decide on whether you're going to use [NGINX](nginx.md) or [Apache](apache.md) and follow the respective guide.
Note that Alliance Auth is designed to run with web servers on HTTPS. While running on HTTP is technically possible, it is not recommended for production use, and some functions (e.g. Email confirmation links) will not work properly.
Note that Alliance Auth is designed to run with web servers on HTTPS. While running on HTTP is technically possible, it is not recommended for production use, and some functions (e.g., Email confirmation links) will not work properly.
## Updating
Periodically [new releases](https://gitlab.com/allianceauth/allianceauth/tags) are issued with bug fixes and new features. Be sure to read the [release notes](https://gitlab.com/allianceauth/allianceauth/-/releases) which will highlight changes.
To update your install, swap to your allianceserver user
To update your installation, swap to your allianceserver user
```shell
sudo su allianceserver
@@ -631,7 +633,7 @@ Some releases come with new or changed models. Update your database to reflect t
python /home/allianceserver/myauth/manage.py migrate
```
Finally, some releases come with new or changed static files. Run the following command to update your static files folder:
Finally, some releases come with new or changed static files. Run the following command to update your static files' folder:
```shell
python /home/allianceserver/myauth/manage.py collectstatic --noinput