minor doc structure changes

This commit is contained in:
Ariel Rin
2023-10-07 21:27:08 +10:00
parent efe0c6963b
commit 24376262f0
6 changed files with 6 additions and 110 deletions

View File

@@ -13,7 +13,7 @@ Welcome to the official documentation for **Alliance Auth**!
:caption: Contents
installation/index
installation containerized/index
installation-containerized/index
features/index
maintenance/index
support/index

View File

@@ -1,4 +1,4 @@
# Installation -- Docker
# Docker
## Prerequisites
@@ -57,7 +57,7 @@ Using a custom docker image is the preferred approach, as it gives you the stabi
1. Add each additional package that you want to install to a single line in `conf/requirements.txt`. It is recommended, but not required, that you include a version number as well. This will keep your packages from magically updating. You can lookup packages on <https://package.wiki>, and copy everything after `pip install` from the top of the page to use the most recent version. It should look something like `allianceauth-signal-pings==0.0.7`. Every entry in this file should be on a separate line
1. In `docker-compose.yml`, comment out the `image` line under `allianceauth` (line 36... ish) and uncomment the `build` section
1. run `docker-compose --env-file=.env up -d`, your custom container will be built, and auth will have your new packages. Make sure to follow the package's instructions on config values that go in `local.py`
1. run `docker-compose exec allianceauth bash` to open up a terminal inside your auth container
1. run `docker-compose exec allianceauth_gunicorn bash` to open up a terminal inside your auth container
1. run `allianceauth update myauth`
1. run `auth migrate`
1. run `auth collectstatic`
@@ -85,17 +85,3 @@ _NOTE: If you specify a version of allianceauth in your `requirements.txt` in a
1. Update the versions in your `requirements.txt` file
1. Run `docker-compose build`
1. Run `docker-compose --env-file=.env up -d`
## Notes
### Apple M1 Support
If you want to run locally on an M1 powered Apple device, you'll need to add `platform: linux/x86_64` under each container in `docker-compose.yml` as the auth container is not compiled for ARM (other containers may work without this, but it's known to work if added to all containers).
Example:
```yaml
redis:
platform: linux/x86_64
image: redis:6.2
```

View File

@@ -1,4 +1,4 @@
# Installation
# Installation - Containerized
This document describes how to install **Alliance Auth** using various Containerization techniques.

View File

@@ -1,4 +1,4 @@
# Installation
# Installation - Bare Metal
This chapter contains the main installation guides for **Alliance Auth**.