6.4 KiB
Mumble
Mumble is a free voice chat server. While not as flashy as TeamSpeak, it has all the functionality and is easier to customize. And is better. I may be slightly biased.
.. note::
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.
.. note::
Same as the official installation guide this guide is assuming you are performing all steps as ``root`` user.
.. warning::
This guide is currently for Ubuntu only.
Installations
Installing Mumble Server
The mumble server package can be retrieved from a repository, which we need to add:
apt-add-repository ppa:mumble/release
apt-get update
Now three packages need to be installed:
apt-get install python-software-properties mumble-server libqt5sql5-mysql
Installing Mumble Authenticator
Next, we need to download the latest authenticator release from the authenticator repository.
git clone https://gitlab.com/allianceauth/mumble-authenticator /home/allianceserver/mumble-authenticator
We will now install the authenticator into your Auth virtual environment. Please make sure to activate it first:
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.
pip install -r requirements.txt
Configuring Mumble Server
The mumble server needs it's own database. Open an SQL shell with mysql -u root -p
and execute the SQL commands to create it:
CREATE DATABASE alliance_mumble CHARACTER SET utf8mb4;
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:
nano /etc/mumble-server.ini
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 userdbPassword=
that user’s passworddbPort=3306
dbPrefix=murmur_
To name your root channel, uncomment and set registerName=
to whatever cool name you want
Save and close the file.
To get Mumble superuser account credentials, run the following:
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.
Now restart the server to see the changes reflected.
service mumble-server restart
That’s it! Your server is ready to be connected to at example.com:64738
Configuring Mumble Authenticator
The ICE authenticator lives in the mumble-authenticator repository, cd to the directory where you cloned it.
Make a copy of the default config:
cp authenticator.ini.example authenticator.ini
Edit authenticator.ini
and change these values:
[database]
user =
your allianceserver MySQL userpassword =
your allianceserver MySQL user's password
[ice]
secret =
theicewritesecret
password set earlier
Test your configuration by starting it:
python /home/allianceserver/mumble-authenticator/authenticator.py
And finally ensure the allianceserver user has read/write permissions to the mumble authenticator files before proceeding:
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:
[program:authenticator]
command=/home/allianceserver/venv/auth/bin/python authenticator.py
directory=/home/allianceserver/mumble-authenticator
user=allianceserver
stdout_logfile=/home/allianceserver/myauth/log/authenticator.log
stderr_logfile=/home/allianceserver/myauth/log/authenticator.log
autostart=true
autorestart=true
startsecs=10
priority=996
In addition we'd recommend to add the authenticator to Auth's restart group in your supervisor conf. For that you need to add it to the group line as shown in the following example:
[group:myauth]
programs=beat,worker,gunicorn,authenticator
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:
supervisor stop myauth:
systemctl restart supervisor
Configuring Auth
In your auth project's settings file (myauth/settings/local.py
), do the following:
- Add
'allianceauth.services.modules.mumble',
to yourINSTALLED_APPS
list - set
MUMBLE_URL
to the public address of your mumble server. Do not include any leadinghttp://
ormumble://
.
Example config:
# Installed apps
INSTALLED_APPS += [
# ...
'allianceauth.services.modules.mumble'
# ...
]
# Mumble Configuration
MUMBLE_URL = "mumble.example.com"
Finally, run migrations and restart your supervisor to complete the setup:
python /home/allianceserver/myauth/manage.py migrate
supervisorctl restart myauth:
Permissions on Auth
To enable the mumble service for users on Auth you need to give them the access_mumble
permission. This permission is often added to the Member
state.
.. note::
Note that groups will only be created on Mumble automatically when a user joins who is in the group.
ACL configuration
On a freshly installed mumble server only your superuser has the right to configure ACLs and create channels. The credentials for logging in with your superuser are:
- user:
SuperUser
- password: what you defined when configuring your mumble server