Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-07-09 04:20:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs to python312, drop old OS

Browse Source
This commit is contained in:
Joel Falknau 2025-03-06 11:28:19 +10:00
parent c7db4f0bd3
commit 876f1e48e7
No known key found for this signature in database
7 changed files with 67 additions and 304 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/development/dev_setup/aa-dev-setup-wsl-vsc-v2.md
View File

@ -67,13 +67,13 @@ sudo apt-get install gettext
Next, we need to install Python and related development tools.
:::{note}
Should your Ubuntu come with a newer version of Python we recommend to still set up your dev environment with the oldest Python 3 version currently supported by AA (e.g., Python 3.8 at this time of writing) to ensure your apps are compatible with all current AA installations
Should your Ubuntu come with a newer version of Python we recommend to still set up your dev environment with the oldest Python 3 version currently supported by AA (e.g., Python 3.10 at this time of writing) to ensure your apps are compatible with all current AA installations
You can check out this `page <https://askubuntu.com/questions/682869/how-do-i-install-a-different-python-version-using-apt-get/1195153>`_ on how to install additional Python versions on Ubuntu.
If you install a different python version from the default, you need to adjust some commands below to install appopriate versions of those packages, for example, using Python 3.8 you might need to run the following after using the setup steps for the repository mentioned in the AskUbuntu post above:
If you install a different python version from the default, you need to adjust some commands below to install appopriate versions of those packages, for example, using Python 3.10 you might need to run the following after using the setup steps for the repository mentioned in the AskUbuntu post above:
```shell
sudo apt-get install python3.8 python3.8-dev python3.8-venv python3-setuptools python3-pip python-pip
sudo apt-get install python3.10 python3.10-dev python3.10-venv python3-setuptools python3-pip python-pip
```
:::

8
docs/features/services/mumble.md
View File

@ -17,14 +17,14 @@ This guide is currently for Ubuntu only.
The mumble server package can be retrieved from a repository, which we need to add:
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo apt-add-repository ppa:mumble/release
```
:::
:::{group-tab} CentOS 7, Stream 8, Stream 9
:::{group-tab} CentOS Stream 9, 10
sudo yum install epel-release
sudo yum update
@ -35,14 +35,14 @@ sudo yum update
Now three packages need to be installed:
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo apt-get install software-properties-common mumble-server libqt5sql5-mysql
```
:::
:::{group-tab} CentOS 7, Stream 8, Stream 9
:::{group-tab} CentOS Stream 9, 10
sudo yum install mumble-server

30
docs/features/services/openfire.md
View File

@ -24,28 +24,14 @@ BROADCAST_SERVICE_NAME = "broadcast"
Openfire require a Java 8 runtime environment.
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo apt-get install openjdk-11-jre
```
:::
:::{group-tab} CentOS 7
```shell
sudo yum install java-11-openjdk java-11-openjdk-devel
```
:::
:::{group-tab} CentOS Stream 8
```shell
sudo dnf install java-11-openjdk java-11-openjdk-devel
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
sudo dnf install java-11-openjdk java-11-openjdk-devel
@ -73,18 +59,10 @@ cd ~
Download and install the package, replacing the URL with the latest you got from the Openfire download page earlier
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204
:::{group-tab} Ubuntu 2204, 2404
:::
:::{group-tab} CentOS 7
wget <https://www.igniterealtime.org/downloadServlet?filename=openfire/openfire_4.7.2_all.deb>
dpkg -i openfire_4.7.2_all.deb
:::
:::{group-tab} CentOS Stream 8
wget <https://www.igniterealtime.org/downloadServlet?filename=openfire/openfire-4.7.2-1.noarch.rpm>
yum install -y openfire-4.7.2-1.noarch.rpm
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
wget <https://www.igniterealtime.org/downloadServlet?filename=openfire/openfire-4.7.2-1.noarch.rpm>
yum install -y openfire-4.7.2-1.noarch.rpm
:::

206
docs/installation/allianceauth.md
View File

@ -14,11 +14,10 @@ Alliance Auth can be installed on any in-support *nix operating system.
Our install documentation targets the following operating systems.
- Ubuntu 20.04 - Not Recommended for new installs
- Ubuntu 22.04
- Centos 7
- CentOS Stream 8
- Ubuntu 22.04 (New installs please use 2404)
- Ubutnu 24.04
- CentOS Stream 9
- CentOS Stream 10
To install on your favorite flavour of Linux, identify and install equivalent packages to the ones listed here.
@ -27,7 +26,7 @@ To install on your favorite flavour of Linux, identify and install equivalent pa
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, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo apt-get update
@ -36,24 +35,7 @@ sudo do-dist-upgrade
```
:::
:::{group-tab} CentOS 7
```shell
yum install epel-release
sudo yum upgrade
```
:::
:::{group-tab} CentOS Stream 8
```shell
sudo dnf config-manager --set-enabled powertools
sudo dnf install epel-release epel-next-release
sudo yum upgrade
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
sudo dnf config-manager --set-enabled crb
@ -66,58 +48,33 @@ sudo yum upgrade
### Python
Install Python 3.11 and related tools on your system.
Install Python 3.12 and related tools on your system.
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204
```shell
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.11 python3.11-dev python3.11-venv
sudo apt-get install python3.12 python3.12-dev python3.12-venv
```
:::
:::{group-tab} CentOS 7
We need to build Python from source
:::{group-tab} Ubuntu 2404
```bash
cd ~
sudo yum install gcc openssl-devel bzip2-devel libffi-devel wget
wget https://www.python.org/ftp/python/3.11.7/Python-3.11.7.tgz
tar xvf Python-3.11.7.tgz
cd Python-3.11.7/
./configure --enable-optimizations --enable-shared
sudo make altinstall
```shell
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.12 python3.12-dev python3.12-venv
```
:::
:::{group-tab} CentOS Stream 8
We need to build Python from source
:::{group-tab} CentOS Stream 9, 10
```bash
cd ~
sudo yum install gcc openssl-devel bzip2-devel libffi-devel wget
wget https://www.python.org/ftp/python/3.11.7/Python-3.11.7.tgz
tar xvf Python-3.11.7.tgz
cd Python-3.11.7/
./configure --enable-optimizations --enable-shared
sudo make altinstall
```
sudo dnf update
sudo dnf install python3.12 python3.12-dev python3.12-venv
:::
:::{group-tab} CentOS Stream 9
We need to build Python from source
```bash
cd ~
sudo yum install gcc openssl-devel bzip2-devel libffi-devel wget
wget https://www.python.org/ftp/python/3.11.7/Python-3.11.7.tgz
tar xvf Python-3.11.7.tgz
cd Python-3.11.7/
./configure --enable-optimizations --enable-shared
sudo make altinstall
```
:::
@ -128,32 +85,24 @@ sudo make altinstall
It's recommended to use a database service instead of SQLite. Many options are available, but this guide will use MariaDB 10.11
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
Follow the instructions at <https://mariadb.org/download/?t=repo-config&d=20.04+%22focal%22&v=10.11&r_m=osuosl> to add the MariaDB repository to your host.
:::{group-tab} Ubuntu 2204
Follow the instructions at <https://mariadb.org/download/?t=repo-config&d=22.04+%22noble%22&v=11.4> to add the MariaDB repository to your host.
```shell
sudo apt-get install mariadb-server mariadb-client libmysqlclient-dev
```
:::
:::{group-tab} CentOS 7
Follow the instructions at <https://mariadb.org/download/?t=repo-config&d=CentOS+7&v=10.11&r_m=osuosl> to add the MariaDB repository to your host.
:::{group-tab} Ubuntu 2404
Follow the instructions at <https://mariadb.org/download/?t=repo-config&d=24.04+%22noble%22&v=11.4> to add the MariaDB repository to your host.
```shell
sudo yum install MariaDB-server MariaDB-client MariaDB-devel MariaDB-shared
sudo apt-get install mariadb-server mariadb-client libmysqlclient-dev
```
:::
:::{group-tab} CentOS Stream 8
Follow the instructions at <https://mariadb.org/download/?t=repo-config&d=CentOS+Stream&v=10.11&r_m=osuosl> to add the MariaDB repository to your host.
```shell
sudo dnf install mariadb mariadb-server mariadb-devel
```
:::
:::{group-tab} CentOS Stream 9
Follow the instructions at <https://mariadb.org/download/?t=repo-config&d=CentOS+Stream&v=10.11&r_m=osuosl> to add the MariaDB repository to your host.
:::{group-tab} CentOS Stream 9, 10
Follow the instructions at <https://mariadb.org/download/?t=repo-config&d=CentOS+Stream&v=11.4> to add the MariaDB repository to your host.
```shell
sudo dnf install mariadb mariadb-server mariadb-devel
@ -164,16 +113,10 @@ sudo dnf install mariadb mariadb-server mariadb-devel
:::::{important}
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
If you don't plan on running the database on the same server as auth you still need to install the `libmysqlclient-dev` package
:::
:::{group-tab} CentOS 7
If you don't plan on running the database on the same server as auth you still need to install the `mariadb-devel` package
:::
:::{group-tab} CentOS Stream 8
If you don't plan on running the database on the same server as auth you still need to install the `mariadb-devel` package
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
If you don't plan on running the database on the same server as auth you still need to install the `mariadb-devel` package
:::
::::
@ -185,9 +128,10 @@ A few extra utilities are also required for the installation of packages.
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo apt-get install lsb-release curl gpg
curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg
sudo chmod 644 /usr/share/keyrings/redis-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
@ -195,32 +139,13 @@ sudo apt-get update
sudo apt-get install unzip git redis-server curl libssl-dev libbz2-dev libffi-dev build-essential pkg-config
```
:::
:::{group-tab} CentOS 7
```shell
sudo yum install gcc gcc-c++ unzip git redis curl bzip2-devel openssl-devel libffi-devel wget pkg-config
```
```shell
sudo systemctl enable redis.service
sudo systemctl start redis.service
sudo systemctl enable redis-server
sudo systemctl start redis-server
```
:::
:::{group-tab} CentOS Stream 8
```shell
sudo dnf install gcc gcc-c++ unzip git redis curl bzip2-devel openssl-devel libffi-devel wget
```
```shell
sudo systemctl enable redis.service
sudo systemctl start redis.service
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
sudo dnf install gcc gcc-c++ unzip git redis curl bzip2-devel openssl-devel libffi-devel wget
@ -282,28 +207,15 @@ mysql_secure_installation
For security and permissions, it's highly recommended you create a separate user to install auth under. Do not log in as this account.
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo adduser --disabled-login allianceserver --shell /bin/bash
```
:::
:::{group-tab} CentOS 7
```shell
sudo passwd -l allianceserver
```
:::
:::{group-tab} CentOS Stream 8
```shell
sudo passwd -l allianceserver
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
sudo passwd -l allianceserver
@ -354,7 +266,7 @@ Your python3.x command/version may vary depending on your installed python versi
:::
```shell
python3.11 -m venv /home/allianceserver/venv/auth/
python3.12 -m venv /home/allianceserver/venv/auth/
```
:::{tip}
@ -497,44 +409,14 @@ exit
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo apt-get install supervisor
```
:::
:::{group-tab} CentOS 7
```shell
sudo dnf install supervisor
```
```shell
sudo systemctl enable supervisord.service
```
```shell
sudo systemctl start supervisord.service
```
:::
:::{group-tab} CentOS Stream 8
```shell
sudo dnf install supervisor
```
```shell
sudo systemctl enable supervisord.service
```
```shell
sudo systemctl start supervisord.service
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
sudo dnf install supervisor
@ -554,28 +436,14 @@ sudo systemctl start supervisord.service
Once installed, it needs a configuration file to know which processes to watch. Your Alliance Auth project comes with a ready-to-use template which will ensure the Celery workers, Celery task scheduler and Gunicorn are all running.
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
ln -s /home/allianceserver/myauth/supervisor.conf /etc/supervisor/conf.d/myauth.conf
```
:::
:::{group-tab} CentOS 7
```shell
sudo ln -s /home/allianceserver/myauth/supervisor.conf /etc/supervisord.d/myauth.ini
```
:::
:::{group-tab} CentOS Stream 8
```shell
sudo ln -s /home/allianceserver/myauth/supervisor.conf /etc/supervisord.d/myauth.ini
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
sudo ln -s /home/allianceserver/myauth/supervisor.conf /etc/supervisord.d/myauth.ini

48
docs/installation/apache.md
View File

@ -10,28 +10,14 @@ If you're using a small VPS to host services with very limited memory, consider
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
apt-get install apache2
```
:::
:::{group-tab} CentOS 7
```shell
yum install httpd
```
:::
:::{group-tab} CentOS Stream 8
```shell
dnf install httpd
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
systemctl enable httpd
@ -41,8 +27,6 @@ systemctl start httpd
:::
::::
CentOS 7, Stream 8, Stream 9
## Configuration
### Permissions
@ -50,28 +34,14 @@ CentOS 7, Stream 8, Stream 9
Apache needs to be able to read the folder containing your auth project's static files.
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
chown -R www-data:www-data /var/www/myauth/static
```
:::
:::{group-tab} CentOS 7
```shell
chown -R apache:apache /var/www/myauth/static
```
:::
:::{group-tab} CentOS Stream 8
```shell
chown -R apache:apache /var/www/myauth/static
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
chown -R apache:apache /var/www/myauth/static
@ -87,7 +57,7 @@ Apache serves sites through defined virtual hosts. These are located in `/etc/ap
A virtual host for auth needs only proxy requests to your WSGI server (Gunicorn if you followed the installation guide) and serve static files. Examples can be found below. Create your config in its own file e.g. `myauth.conf`
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
To proxy and modify headers a few mods need to be enabled.
```shell
@ -98,13 +68,7 @@ a2enmod headers
Create a new config file for auth e.g. `/etc/apache2/sites-available/myauth.conf` and fill out the virtual host configuration. To enable your config use `a2ensite myauth.conf` and then reload apache with `service apache2 reload`.
:::
:::{group-tab} CentOS 7
Place your virtual host configuration in the appropriate section within `/etc/httpd/conf.d/httpd.conf` and restart the httpd service with `systemctl restart httpd`.
:::
:::{group-tab} CentOS Stream 8
Place your virtual host configuration in the appropriate section within `/etc/httpd/conf.d/httpd.conf` and restart the httpd service with `systemctl restart httpd`.
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
Place your virtual host configuration in the appropriate section within `/etc/httpd/conf.d/httpd.conf` and restart the httpd service with `systemctl restart httpd`.
:::
::::

18
docs/installation/nginx.md
View File

@ -42,28 +42,14 @@ You will need to have [Gunicorn](gunicorn.md) or some other WSGI server setup fo
## Install
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo apt-get install nginx
```
:::
:::{group-tab} CentOS 7
```shell
sudo yum install nginx
```
:::
:::{group-tab} CentOS Stream 8
```shell
sudo dnf install nginx
```
:::
:::{group-tab} CentOS Stream 9
:::{group-tab} CentOS Stream 9, 10
```shell
sudo dnf install nginx

55
docs/installation/upgrade_python.md
View File

@ -14,62 +14,29 @@ To run AA with a newer Python 3 version than your system's default, you need to
To install other Python versions than those included with your distribution, you need to add a new installation repository. Then you can install the specific Python 3 to your system.
:::{note}
Ubuntu 2204 ships with Python 3.10 already
:::
Centos Stream 8/9:
:::{note}
A Python 3.9 Package is available for Stream 8 and 9. You _may_ use this instead of building your own package. But our documentation will assume Python3.11, and you may need to substitute as necessary
sudo dnf install python39 python39-devel
:::
::::{tabs}
:::{group-tab} Ubuntu 2004, 2204, 2404
:::{group-tab} Ubuntu 2204, 2404
```shell
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install python3.11 python3.11-dev python3.11-venv
sudo apt-get install python3.12 python3.12-dev python3.12-venv
```
:::
:::{group-tab} CentOS 7
:::{group-tab} Ubuntu 2404
```bash
cd ~
sudo yum install gcc openssl-devel bzip2-devel libffi-devel wget
wget https://www.python.org/ftp/python/3.11.7/Python-3.11.7.tgz
tar xvf Python-3.11.7.tgz
cd Python-3.11.7/
./configure --enable-optimizations --enable-shared
sudo make altinstall
```shell
sudo apt-get update
sudo apt-get install python3.12 python3.12-dev python3.12-venv
```
:::
:::{group-tab} CentOS Stream 8
:::{group-tab} CentOS Stream 9, 10
```bash
cd ~
sudo yum install gcc openssl-devel bzip2-devel libffi-devel wget
wget https://www.python.org/ftp/python/3.11.7/Python-3.11.7.tgz
tar xvf Python-3.11.7.tgz
cd Python-3.11.7/
./configure --enable-optimizations --enable-shared
sudo make altinstall
```
:::
:::{group-tab} CentOS Stream 9
```bash
cd ~
sudo yum install gcc openssl-devel bzip2-devel libffi-devel wget
wget https://www.python.org/ftp/python/3.11.7/Python-3.11.7.tgz
tar xvf Python-3.11.7.tgz
cd Python-3.11.7/
./configure --enable-optimizations --enable-shared
sudo make altinstall
sudo dnf update
sudo dnf install python3.12 python3.12-dev python3.12-venv
```
:::
@ -201,10 +168,10 @@ mv /home/allianceserver/venv/auth /home/allianceserver/venv/auth_old
## Create your new venv
Now let's create our new venv with Python 3.11 and activate it:
Now let's create our new venv with Python 3.12 and activate it:
```shell
python3.11 -m venv /home/allianceserver/venv/auth
python3.12 -m venv /home/allianceserver/venv/auth
```
```shell