mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-11 13:30:17 +02:00
c4c6d13d36
Added documentation for writing service integrations Added menu hook documentation Added notes about installing service modules before following service installation guide
89 lines
3.3 KiB
Markdown
89 lines
3.3 KiB
Markdown
# Mumble
|
||
|
||
Add `services.modules.mumble` to your `INSTALLED_APPS` list and run migrations before continuing with this guide to ensure the service is installed.
|
||
|
||
## Overview
|
||
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.
|
||
|
||
## Dependencies
|
||
The mumble server package can be retrieved from a repository we need to add, mumble/release.
|
||
|
||
sudo apt-add-repository ppa:mumble/release
|
||
sudo apt-get update
|
||
|
||
Now two packages need to be installed:
|
||
|
||
sudo apt-get install python-software-properties mumble-server
|
||
|
||
You will also need to install the python dependencies for the authenticator script:
|
||
|
||
pip install -r thirdparty/Mumble/requirements.txt
|
||
|
||
## Configuring Mumble
|
||
Mumble ships with a configuration file that needs customization. By default it’s located at /etc/mumble-server.ini. Open it with your favourite text editor:
|
||
|
||
sudo nano /etc/mumble-server.ini
|
||
|
||
REQUIRED: To enable the ICE authenticator, edit the following:
|
||
|
||
- `icesecretwrite=MY_CLEVER_PASSWORD`, obviously choosing a secure password
|
||
|
||
By default mumble operates on sqlite which is fine, but slower than a dedicated MySQL server. To customize the database, edit the following:
|
||
|
||
- uncomment the database line, and change it to `database=alliance_mumble`
|
||
- `dbDriver=QMYSQL`
|
||
- `dbUsername=allianceserver` or whatever you called the AllianceAuth 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 (control + O, control + X).
|
||
|
||
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 needed to manage ACLs.
|
||
|
||
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
|
||
|
||
## Configuring the Authenticator
|
||
|
||
The ICE authenticator lives in `allianceauth/thirdparty/Mumble/`, cd to this directory.
|
||
|
||
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 user
|
||
- `password = ` your allianceserver MySQL user's password
|
||
- `[ice]`
|
||
- `secret = ` the `icewritesecret` password set earlier
|
||
|
||
Test your configuration by starting it: `python authenticator.py`
|
||
|
||
## Running the Authenticator
|
||
|
||
The authenticator needs to be running 24/7 to validate users on Mumble. The best way is to run it in a screen much like celery:
|
||
|
||
screen -dm bash -c 'python authenticator.py'
|
||
|
||
Much like celery tasks, this process needs to be started every time the server reboots. It needs to be launched from this directory, so cd to this folder to launch.
|
||
|
||
Note that groups will only be created on Mumble automatically when a user joins who is in the group.
|
||
|
||
## Making and Managing Channels
|
||
ACL is really above the scope of this guide. Once AllianceAuth creates your groups, go ahead and follow one of the wonderful web guides available on how to set up channel ACL properly.
|
||
|
||
## Setup Complete
|
||
You’ve finished the steps required to make AllianceAuth work with Mumble. Play around with it and make it your own.
|