Merge branch 'master' of gitlab.com:allianceauth/allianceauth into v5.x

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/mumble-docker.md

@@ -8,7 +8,7 @@ Mumble is a free voice chat server. While not as flashy as TeamSpeak, it has all
 
 In your auth project's settings file (`aa-docker/conf/local.py`), do the following:
 
-- Add `'allianceauth.services.modules.mumble',` to your `INSTALLED_APPS` list
+- Add `'allianceauth.services.modules.mumble',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to your auth project's settings file:
 
 ```python

docs/features/services/mumble.md

@@ -14,25 +14,38 @@ This guide is currently for Ubuntu only.
 
 ### Installing Mumble Server
 
-::::{tabs}
-:::{group-tab} Ubuntu 2004, 2204
-
 The mumble server package can be retrieved from a repository, which we need to add:
 
+::::{tabs}
+:::{group-tab} Ubuntu 2004, 2204, 2404
+
 ```shell
 sudo apt-add-repository ppa:mumble/release
 ```
 
-```shell
-sudo apt-get update
-```
+:::
+:::{group-tab} CentOS 7, Stream 8, Stream 9
+
+sudo yum install epel-release
+sudo yum update
+
+:::
+::::
 
 Now three packages need to be installed:
 
+::::{tabs}
+:::{group-tab} Ubuntu 2004, 2204, 2404
+
 ```shell
-sudo apt-get install python-software-properties mumble-server libqt5sql5-mysql
+sudo apt-get install software-properties-common mumble-server libqt5sql5-mysql
 ```
 
+:::
+:::{group-tab} CentOS 7, Stream 8, Stream 9
+
+sudo yum install mumble-server
+
 :::
 ::::
 
@@ -58,17 +71,7 @@ pip install -r requirements.txt
 
 ## Configuring Mumble Server
 
-The mumble server needs its own database. Open an SQL shell with `mysql -u root -p` and execute the SQL commands to create it:
-
-```sql
-CREATE DATABASE alliance_mumble CHARACTER SET utf8mb4;
-```
-
-```sql
-GRANT ALL PRIVILEGES ON alliance_mumble . * TO 'allianceserver'@'localhost';
-```
-
-Mumble ships with a configuration file that needs customization. By default, it’s located at `/etc/mumble-server.ini`. Open it with your favorite text editor:
+Mumble ships with a configuration file that needs customization. By default, it's located at `/etc/mumble-server.ini`. Open it with your favorite text editor:
 
 ```shell
 sudo nano /etc/mumble-server.ini
@@ -79,15 +82,6 @@ We need to enable the ICE authenticator. Edit the following:
 - `icesecretwrite=MY_CLEVER_PASSWORD`, obviously choosing a secure password
 - ensure the line containing `Ice="tcp -h 127.0.0.1 -p 6502"` is uncommented
 
-We also want to enable Mumble to use the previously created MySQL / MariaDB database, edit the following:
-
-- uncomment the database line, and change it to `database=alliance_mumble`
-- `dbDriver=QMYSQL`
-- `dbUsername=allianceserver` or whatever you called the Alliance Auth MySQL user
-- `dbPassword=` that user’s password
-- `dbPort=3306`
-- `dbPrefix=murmur_`
-
 To name your root channel, uncomment and set `registerName=` to whatever cool name you want
 
 Save and close the file.
@@ -98,7 +92,7 @@ To get Mumble superuser account credentials, run the following:
 sudo dpkg-reconfigure mumble-server
 ```
 
-Set the password to something you’ll remember and write it down. This is your superuser password and later needed to manage ACLs.
+Set the password to something you'll remember and write it down. This is your superuser password and later needed to manage ACLs.
 
 Now restart the server to see the changes reflected.
 
@@ -106,7 +100,7 @@ Now restart the server to see the changes reflected.
 sudo service mumble-server restart
 ```
 
-That’s it! Your server is ready to be connected to at example.com:64738
+That's it! Your server is ready to be connected to at example.com:64738
 
 ## Configuring Mumble Authenticator
 

docs/features/services/openfire-docker.md

@@ -8,7 +8,7 @@ Openfire is a Jabber (XMPP) server.
 
 In your auth project's settings file (`aa-docker/conf/local.py`), do the following:
 
-- Add `'allianceauth.services.modules.openfire',` to your `INSTALLED_APPS` list
+- Add `'allianceauth.services.modules.openfire',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to your auth project's settings file:
 
 ```python

docs/features/services/openfire.md

@@ -4,7 +4,7 @@ Openfire is a Jabber (XMPP) server.
 
 ## Prepare Your Settings
 
-- Add `'allianceauth.services.modules.openfire',` to your `INSTALLED_APPS` list
+- Add `'allianceauth.services.modules.openfire',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to your auth project's settings file:
 
 ```python
@@ -108,7 +108,7 @@ exit;
 
 The remainder of the setup occurs through Openfire’s web interface. Navigate to <http://example.com:9090>, or if you’re behind CloudFlare, go straight to your server’s IP:9090.
 
-Select your language. I sure hope it’s English if you’re reading this guide.
+Select your language.
 
 Under Server Settings, set the Domain to `example.com` replacing it with your actual domain. Don’t touch the rest.
 

docs/features/services/phpbb3.md

@@ -12,7 +12,7 @@ phpBB3 requires PHP installed in your web server. Apache has `mod_php`, NGINX re
 
 In your auth project's settings file, do the following:
 
-- Add `'allianceauth.services.modules.phpbb3',` to your `INSTALLED_APPS` list
+- Add `'allianceauth.services.modules.phpbb3',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to the bottom of the settings file:
 
 ```python
@@ -25,6 +25,7 @@ DATABASES['phpbb3'] = {
     'PASSWORD': 'password',
     'HOST': '127.0.0.1',
     'PORT': '3306',
+    'OPTIONS': {'charset': 'utf8mb4'},
 }
 ```
 

docs/features/services/smf.md

@@ -12,7 +12,7 @@ SMF requires PHP installed in your web server. Apache has `mod_php`, NGINX requi
 
 In your auth project's settings file, do the following:
 
-- Add `'allianceauth.services.modules.smf',` to your `INSTALLED_APPS` list
+- Add `'allianceauth.services.modules.smf',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to the bottom of the settings file:
 
 ```python
@@ -25,6 +25,7 @@ DATABASES['smf'] = {
     'PASSWORD': 'password',
     'HOST': '127.0.0.1',
     'PORT': '3306',
+    'OPTIONS': {'charset': 'utf8mb4'},
 }
 ```
 

docs/features/services/teamspeak3-docker.md

@@ -14,7 +14,7 @@ Sticking with TS3? Alright, I tried.
 
 In your auth project's settings file (`aa-docker/conf/local.py`), do the following:
 
-- Add `'allianceauth.services.modules.teamspeak',` to your `INSTALLED_APPS` list
+- Add `'allianceauth.services.modules.teamspeak',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to your auth project's settings file:
 
 ```python
@@ -32,7 +32,7 @@ CELERYBEAT_SCHEDULE['run_ts3_group_update'] = {
 }
 ```
 
-Add the following lines to your `.env` file
+- Add the following lines to your `.env` file
 
 ```bash
 # Temspeak
@@ -152,7 +152,7 @@ If you have SSH access to the server hosting it, you need to locate the teamspea
 
 ### `520 invalid loginname or password`
 
-The serverquery account login specified in local.py is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them.
+The serverquery account login specified in `local.py` is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them.
 
 ### `2568 insufficient client permissions`
 

docs/features/services/teamspeak3.md

@@ -14,7 +14,7 @@ Sticking with TS3? Alright, I tried.
 
 In your auth project's settings file, do the following:
 
-- Add `'allianceauth.services.modules.teamspeak3',` to your `INSTALLED_APPS` list
+- Add `'allianceauth.services.modules.teamspeak3',` to `INSTALLED_APPS` in your `local.py`
 - Append the following to the bottom of the settings file:
 
 ```python
@@ -170,7 +170,7 @@ If you have SSH access to the server hosting it, you need to locate the teamspea
 
 ### `520 invalid loginname or password`
 
-The serverquery account login specified in local.py is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them.
+The serverquery account login specified in `local.py` is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them.
 
 ### `2568 insufficient client permissions`
 

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.