split maintenance tasks into bare metal / docker

This commit is contained in:
Joel Falknau
2024-09-03 12:24:17 +10:00
parent cbe6c821cc
commit 98efb9f887
12 changed files with 380 additions and 28 deletions

View File

@@ -4,12 +4,14 @@
[XenForo](https://xenforo.com/) is a popular, paid forum. This guide will assume that you already have XenForo installed with a valid license (please keep in mind that XenForo is not free nor open-source, therefore, you need to purchase a license first). If you come across any problems related with the installation of XenForo please contact their support service.
## Prepare Your Settings
## Setup Auth
### Prepare Your Settings
In your auth project's settings file, do the following:
- Add `'allianceauth.services.modules.xenforo',` to your `INSTALLED_APPS` list
- Append the following to your local.py settings file:
- Add `'allianceauth.services.modules.xenforo',` to `INSTALLED_APPS` in your `local.py`
- Append the following to your `local.py` settings file:
```python
# XenForo Configuration
@@ -18,6 +20,32 @@ XENFORO_DEFAULT_GROUP = 0
XENFORO_APIKEY = 'yourapikey'
```
### Preparing Auth
Before continuing, it is essential to perform Django Maintenance and restart our Web Service and Workers.
::::{tabs}
:::{group-tab} Bare Metal
```shell
python manage.py migrate
python manage.py collectstatic --noinput
supervisorctl restart myauth:
```
:::
:::{group-tab} Containerized
```shell
docker compose --env-file=.env up -d
docker compose exec allianceauth_gunicorn bash
auth migrate
auth collectstatic
```
:::
::::
## XenAPI
By default, XenForo does not support any kind of API, however, there is a third-party package called [XenAPI](https://github.com/Contex/XenAPI) which provides a simple REST interface by which we can access XenForo's functions to create and edit users.