Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-12-18 23:05:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Refactor Docs with OS Versions and non-root

Browse Source
This commit is contained in:
Ariel Rin
2022-07-30 07:26:42 +00:00
parent f40ebbfba4
commit f5d70a2c48
11 changed files with 424 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -7,11 +7,6 @@ Mumble is a free voice chat server. While not as flashy as TeamSpeak, it has all
Note that this guide assumes that you have installed Auth with the official :doc:`/installation/allianceauth` guide under ``/home/allianceserver`` and that it is called ``myauth``. Accordingly it assumes that you have a service user called ``allianceserver`` that is used to run all Auth services under supervisor.
```
```eval_rst
.. note::
Same as the official installation guide this guide is assuming you are performing all steps as ``root`` user.
```
```eval_rst
.. warning::
This guide is currently for Ubuntu only.
@@ -24,17 +19,17 @@ Mumble is a free voice chat server. While not as flashy as TeamSpeak, it has all
The mumble server package can be retrieved from a repository, which we need to add:
```bash
apt-add-repository ppa:mumble/release
sudo apt-add-repository ppa:mumble/release
```
```bash
apt-get update
sudo apt-get update
```
Now three packages need to be installed:
```bash
apt-get install python-software-properties mumble-server libqt5sql5-mysql
sudo apt-get install python-software-properties mumble-server libqt5sql5-mysql
```
### Installing Mumble Authenticator
@@ -51,7 +46,7 @@ We will now install the authenticator into your Auth virtual environment. Please
source /home/allianceserver/venv/auth/bin/activate
```
Install the python dependencies for the mumble authenticator. Note that this process can take a couple minutes to complete.
Install the python dependencies for the mumble authenticator. Note that this process can take 2-10 minutes to complete.
```bash
pip install -r requirements.txt
@@ -72,7 +67,7 @@ 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:
```bash
nano /etc/mumble-server.ini
sudo nano /etc/mumble-server.ini
```
We need to enable the ICE authenticator. Edit the following:
@@ -96,7 +91,7 @@ Save and close the file.
To get Mumble superuser account credentials, run the following:
```bash
dpkg-reconfigure mumble-server
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.
@@ -104,7 +99,7 @@ Set the password to something you’ll remember and write it down. This is your
Now restart the server to see the changes reflected.
```bash
service mumble-server restart
sudo service mumble-server restart
```
That’s it! Your server is ready to be connected to at example.com:64738
@@ -136,7 +131,7 @@ python /home/allianceserver/mumble-authenticator/authenticator.py
And finally ensure the allianceserver user has read/write permissions to the mumble authenticator files before proceeding:
```bash
chown -R allianceserver:allianceserver /home/allianceserver/mumble-authenticator
sudo chown -R allianceserver:allianceserver /home/allianceserver/mumble-authenticator
```
The authenticator needs to be running 24/7 to validate users on Mumble. This can be achieved by adding a section to your auth project's supervisor config file like the following example:
@@ -165,8 +160,8 @@ priority=999
To enable the changes in your supervisor configuration you need to restart the supervisor process itself. And before we do that we are shutting down the current Auth supervisors gracefully:
```bash
supervisor stop myauth:
systemctl restart supervisor
sudo supervisor stop myauth:
sudo systemctl restart supervisor
```
## Configuring Auth
@@ -255,8 +250,8 @@ There is no way to force your users to update their clients or use Push to Talk,
<https://wiki.mumble.info/wiki/Murmur.ini#Miscellany>
We suggest using Mumble 1.3.0+ for your server and Clients, you can tune this to the latest Patch version.
`suggestVersion=1.3.0`
We suggest using Mumble 1.4.0+ for your server and Clients, you can tune this to the latest Patch version.
`suggestVersion=1.4.230`
If Push to Talk is to your tastes, configure the suggestion as follows
`suggestPushToTalk=true`
@@ -268,7 +263,7 @@ If Push to Talk is to your tastes, configure the suggestion as follows
With the default configuration your mumble server is public. Meaning that everyone who has the address can at least connect to it and might also be able join all channels that don't have any permissions set (Depending on your ACL configured for the root channel). If you want only registered member being able to join your mumble, you have to set a server password. To do so open your mumble server configuration which is by default located at `/etc/mumble-server.ini`.
```bash
nano /etc/mumble-server.ini
sudo nano /etc/mumble-server.ini
```
Now search for `serverpassword=` and set your password here. If there is no such line, simply add it.
@@ -280,7 +275,7 @@ serverpassword=YourSuperSecretServerPassword
Save the file and restart your mumble server afterwards.
```bash
service mumble-server restart
sudo service mumble-server restart
```
From now on, only registered member can join your mumble server. Now if you still want to allow guests to join you have 2 options.

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

@@ -19,20 +19,25 @@ BROADCAST_USER_PASSWORD = ""
BROADCAST_SERVICE_NAME = "broadcast"
```
## Dependencies
## OS Dependencies
Openfire require a Java 8 runtime environment.
Ubuntu:
Ubuntu 1804, 2004, 2204:
```bash
apt-get install openjdk-8-jdk
sudo apt-get install openjdk-11-jre
```
CentOS:
Centos 7:
```bash
yum -y install java-1.8.0-openjdk java-1.8.0-openjdk-devel
sudo yum install java-11-openjdk java-11-openjdk-devel
```
Centos Stream 8, Stream 9:
```bash
sudo dnf install java-11-openjdk java-11-openjdk-devel
```
## Setup
@@ -45,22 +50,26 @@ On your PC, navigate to the [Ignite Realtime downloads section](https://www.igni
Retrieve the file location by copying the URL from the “click here” link, depending on your browser you may have a Copy Link or similar option in your right click menu.
In the console, ensure you’re in your user’s home directory: `cd ~`
In the console, ensure you’re in your user’s home directory:
```bash
cd ~
```
Now download the package. Replace the link below with the link you got earlier.
Download and install the package, replacing the URL with the latest you got from the Openfire download page earlier
`wget https://www.igniterealtime.org/downloadServlet?filename=openfire/openfire_4.2.3_all.deb`
Ubuntu 1804, 2004, 2204:
Now install from the package. Replace the filename with your filename (the last part of the download URL is the file name)
```bash
wget https://www.igniterealtime.org/downloadServlet?filename=openfire/openfire_4.7.2_all.deb
dpkg -i openfire_4.7.2_all.deb
```
Ubuntu:
`dpkg -i openfire_4.2.3_all.deb`
CentOS:
`yum install -y openfire-4.2.3-1.noarch.rpm`
Centos 7, Stream 8, Stream 9:
```bash
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
```
### Create Database
Performance is best when working from a SQL database. If you installed MySQL or MariaDB alongside your auth project, go ahead and create a database for Openfire:

4
docs/features/services/phpbb3.md
View File

@@ -52,13 +52,13 @@ In the console, navigate to your user’s home directory: `cd ~`
Now download using wget, replacing the URL with the URL for the package you just retrieved
```bash
wget https://www.phpbb.com/files/release/phpBB-3.2.2.zip
wget https://download.phpbb.com/pub/release/3.3/3.3.8/phpBB-3.3.8.zip
```
This needs to be unpackaged. Unzip it, replacing the file name with that of the file you just downloaded
```bash
unzip phpBB-3.2.2.zip
unzip phpBB-3.3.8.zip
```
Now we need to move this to our web directory. Usually `/var/www/forums`.

12
docs/features/services/smf.md
View File

@@ -36,17 +36,17 @@ Using your browser, you can download the latest version of SMF to your desktop c
Download using wget, replacing the URL with the URL for the package you just retrieved
```shell
wget https://download.simplemachines.org/index.php?thanks;filename=smf_2-0-15_install.zip
```bash
wget https://download.simplemachines.org/index.php?thanks;filename=smf_2-1-2_install.tar.gz
```
This needs to be unpackaged. Unzip it, replacing the file name with that of the file you just downloaded
```shell
unzip smf_2-0-15_install.zip
````
```bash
unzip smf_2-1-2_install.zip
```
Now we need to move this to our web directory. Usually `/var/www/forums`.
```shell
```bash
mv smf /var/www/forums
````

20
docs/features/services/teamspeak3.md
View File

@@ -34,18 +34,19 @@ CELERYBEAT_SCHEDULE['run_ts3_group_update'] = {
### Download Installer
To install we need a copy of the server. You can find the latest version from [this dl server](http://dl.4players.de/ts/releases/) (I’d recommend getting the latest stable version – find this version number from the [TeamSpeak site](https://www.teamspeak.com/downloads#)). Be sure to get a link to the Linux version.
To install we need a copy of the server. You can find the latest version from the [TeamSpeak site](https://www.teamspeak.com/downloads#)). Be sure to get a link to the Linux version.
Download the server, replacing the link with the link you got earlier.
```text
http://dl.4players.de/ts/releases/3.13.2/teamspeak3-server_linux_amd64-3.13.2.tar.bz2
``` bash
cd ~
wget https://files.teamspeak-services.com/releases/server/3.13.7/teamspeak3-server_linux_amd64-3.13.7.tar.bz2
```
Now we need to extract the file.
```bash
tar -xf teamspeak3-server_linux_amd64-3.1.0.tar.bz2
tar -xf teamspeak3-server_linux_amd64-3.13.7.tar.bz2
```
### Create User
@@ -82,14 +83,19 @@ service teamspeak start
### Update Settings
The console will spit out a block of text. If it does not appear, it can be found with `service teamspeak status`. **SAVE THIS**.
Set your Teamspeak Serveradmin password to a random string
```bash
./ts3server_minimal_runscript.sh inifile=ts3server.ini serveradmin_password=pleasegeneratearandomstring
```
If you plan on claiming the ServerAdmin token, do so with a different TeamSpeak client profile than the one used for your auth account, or you will lose your admin status.
Edit the settings you added to your auth project's settings file earlier, entering the following:
- `TEAMSPEAK3_SERVERQUERY_USER` is `loginname` from that block of text it just spat out (usually `serveradmin`)
- `TEAMSPEAK3_SERVERQUERY_PASSWORD` is `password` from that block of text it just spat out
- `TEAMSPEAK3_SERVERQUERY_USER` is `loginname` from the above bash command (usually `serveradmin`)
- `TEAMSPEAK3_SERVERQUERY_PASSWORD` is `password` following the equals in `serveradmin_password=`
- `TEAMSPEAK_VIRTUAL_SERVER` is the virtual server ID of the server to be managed - it will only ever not be 1 if your server is hosted by a professional company
- `TEAMSPEAK3_PUBLIC_URL` is the public address of your TeamSpeak server. Do not include any leading http:// or teamspeak://