split maintenance tasks into bare metal / docker

docs/features/services/discord.md

@@ -6,13 +6,13 @@ Discord is a web-based instant messaging client with voice. Kind of like TeamSpe
 
 Discord is very popular amongst ad-hoc small groups and larger organizations seeking a modern technology. Alternative voice communications should be investigated for larger than small-medium groups for more advanced features.
 
-## Setup
+## Setup Auth
 
 ### Prepare Your Settings File
 
 Make the following changes in your auth project's settings file (`local.py`):
 
-- Add `'allianceauth.services.modules.discord',` to `INSTALLED_APPS`
+- Add `'allianceauth.services.modules.discord',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to the bottom of the settings file:
 
 ```python
@@ -37,6 +37,34 @@ CELERYBEAT_SCHEDULE['discord.update_all_usernames'] = {
     You will have to add most of the values for these settings, e.g., your Discord server ID (aka guild ID), later in the setup process.
 :::
 
+### 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
+```
+
+:::
+::::
+
+## Setup Discord
+
 ### Creating a Server
 
 Navigate to the [Discord site](https://discord.com/) and register an account, or log in if you have one already.
@@ -67,10 +95,6 @@ Update your auth project's settings file with these pieces of information from t
 - From the OAuth2 > General panel, `DISCORD_APP_SECRET` is the Client Secret
 - From the Bot panel, `DISCORD_BOT_TOKEN` is the Token
 
-### Preparing Auth
-
-Before continuing, it is essential to run migrations and restart Gunicorn and Celery.
-
 ### Adding a Bot to the Server
 
 Once created, navigate to the "Services" page of your Alliance Auth install as the superuser account. At the top there is a big green button labeled "Link Discord Server". Click it, then from the drop-down select the server you created, and then Authorize.

docs/features/services/discourse.md

@@ -1,11 +1,13 @@
 # Discourse
 
-## Prepare Your Settings
+## Setup Auth
+
+### Prepare Your Settings File
 
 In your auth project's settings file, do the following:
 
-- Add `'allianceauth.services.modules.discourse',` to your `INSTALLED_APPS` list
-- Append the following to your local.py settings file:
+- Add `'allianceauth.services.modules.discourse',` to `INSTALLED_APPS` in your `local.py`
+- Append the following to your `local.py` settings file:
 
 ```python
 # Discourse Configuration
@@ -15,6 +17,32 @@ DISCOURSE_API_KEY = ''
 DISCOURSE_SSO_SECRET = ''
 ```
 
+### 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
+```
+
+:::
+::::
+
 ## Install Docker
 
 ```shell

docs/features/services/xenforo.md

@@ -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.