avhost/docker-murmur
Mumble is a VOIP application which allows users to talk to each other via the same server. It uses a client-server architecture, and encrypts all communication to ensure user privacy. Murmur is the server that Mumble clients to connect to. Learn More.
avhost/docker-murmur
enables you to easily run multiple (lightweight) murmur
instances on the same host.
This guide assumes that you already have Docker installed.
An image is available from the Docker Hub registry, built automatically from this repository. It's easy to get started:
docker pull avhost/docker-murmur:1.3.4
You don't need to specify a tag, but it's a good idea to so that you don't
pull latest
and risk getting different versions on different hosts. Versions
are kept in line with the releases from mumble-voip/mumble.
The examples throughout this document assume we are not using a tag for the
sake of brevity. If you pull the image with a tag other than latest
, you
will need to use that tag number when running the image via docker run
.
Now that you have the image pulled, it's time to get a container up and running.
docker run -d \
-p 64738:64738 \
--name murmur-001 \
avhost/docker-murmur
You should now be able to open up the Mumble client, and connect to the server
running at 127.0.0.1:64738
.
The following variables can be passed into the container (when you execute
docker run
) to change various confirguation options.
For example:
docker run -d \
-p 64738:64738 \
-e MUMBLE_SERVERPASSWORD='superSecretPasswordHere' \
--name murmur-001 \
avhost/docker-murmur
Here is a list of all options supported through environment variables:
Environment Variable | Default Value |
---|---|
MUMBLE_ICE | tcp -h 127.0.0.1 -p 6502 |
MUMBLE_ICESECRETREAD | --- |
MUMBLE_ICESECRETWRITE | --- |
MUMBLE_AUTOBANATTEMPTS | 10 |
MUMBLE_AUTOBANTIMEFRAME | 120 |
MUMBLE_AUTOBANTIME | 300 |
MUMBLE_SERVERPASSWORD | --- |
MUMBLE_OBFUSCATE | false |
MUMBLE_SENDVERSION | false |
MUMBLE_KDFITERATIONS | -1 |
MUMBLE_LEGACYPASSWORDHASH | false |
MUMBLE_ALLOWPING | true |
MUMBLE_BANDWIDTH | 7200 |
MUMBLE_TIMEOUT | 30 |
MUMBLE_USERS | 100 |
MUMBLE_USERSPERCHANNEL | 0 |
MUMBLE_USERNAME | `[-=\w\[\]\{\}\(\)\@\ |
MUMBLE_CHANNELNAME | `[ \-=\w\#\[\]\{\}\(\)\@\ |
MUMBLE_DEFAULTCHANNEL | --- |
MUMBLE_REMEMBERCHANNEL | true |
MUMBLE_TEXTMESSAGELENGTH | 5000 |
MUMBLE_IMAGEMESSAGELENGTH | 131072 |
MUMBLE_ALLOWHTML | true |
MUMBLE_OPUSTHRESHOLD | 100 |
MUMBLE_REGISTERHOSTNAME | --- |
MUMBLE_REGISTERPASSWORD | --- |
MUMBLE_REGISTERURL | --- |
MUMBLE_REGISTERNAME | --- |
MUMBLE_SUGGESTVERSION | false |
MUMBLE_SUGGESTPOSITIONAL | --- |
MUMBLE_SUGGESTPUSHTOTALK | --- |
MUMBLE_ENABLESSL | 0 |
MUMBLE_SSLPASSPHRASE | --- |
MUMBLE_SSLCIPHERS | --- |
SUPERUSER_PASSWORD | If not defined, a password will be auto-generated. |
To customize the welcome text, add the contents to welcome.txt
and mount that
into the container at /data/welcome.txt
. Double quote characters ("
) are
escaped automatically, but you may want to double check that your message was
parsed correctly.
Murmur will generate its own SSL certificates when the daemon is started. If you wish to provide your own certificates and ciphers instead, you can do so by following the instructions below.
If MUMBLE_ENABLESSL
is set to 1
, custom SSL is enabled, as long as you have
mounted a certificate and key at the following locations:
SSL certificate should be mounted at /data/cert.pem
/data/intermediate.pem
- this
will be automatically detected.SSL key should be mounted at /data/key.pem
MUMBLE_SSLPASSPHRASE
with the passphrase. This variable does not have
any effect if you have not mounted a key and enabled SSL.Set your preferred cipher suite using MUMBLE_SSLCIPHERS
If the environment variable SUPERUSER_PASSWORD
is not defined when creating
the container, a password will be automatically generated. To view the password
for any container at any time, look at the container's logs. As an example, to
view the SuperUser password is for an instance running in a container
named murmur-001
:
$ docker logs murmur-001 2>&1 | grep SUPERUSER_PASSWORD
> SUPERUSER_PASSWORD: <value>
To update your image locally, simply run docker pull avhost/docker-murmur
.
docker pull avhost/docker-murmur