Public | Automated Build

Last pushed: 8 hours ago
Short Description
Dockerized version of murmur
Full Description

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.

murmur-docker enables you to easily run multiple (lightweight) murmur
instances on the same host.

Getting started

This guide assumes that you already have Docker installed.

Pull the official image

An image is available from the Docker Hub registry,
built automatically from this repository. It's easy to get started:

docker pull sheogorath/murmur-docker

You don't need to specify a version number, but it's a good idea to so that
you don't pull latest and risk getting different versions on different hosts.
You can view the available versions by looking at the Releases
page.

The examples throughout this document assume we are not using a tag. If you
include a tag number when pulling the image, you will need to append that tag
number when running the image via docker run. Further we will assume that you
run the example commands on the same machine as your mumble client.

Create a container

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 \
    sheogorath/murmur-docker

You should now be able to open up the Mumble client, and connect to the server
running at 127.0.0.1:64738.

Configuration options

The following variables can be passed into the container (when you execute
docker run) to change various confirguration options.

For example:

docker run -d \
    -p 64738:64738 \
    -e MUMBLE_SERVERPASSWORD='superSecretPasswordHere' \
    --name murmur-001 \
    sheogorath/murmur-docker

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.

Custom welcome text (Murmur.ini::welcometext)

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.

SSL Certificates (Murmur.ini::SSL)

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

    • If your certificate is signed by an authority that uses a sub-signed or
      "intermediate" certificate, you should either bundle that with your
      certificate, or mount it in separately at /data/intermediate.pem - this
      will be automatically detected.
  • SSL key should be mounted at /data/key.pem

    • If the key has a passphrase, you should define the environment variable
      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

    • This option chooses the cipher suites to make available for use in SSL/TLS.
      See the official documentation for more information.

Logging in as SuperUser

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>

Updating

To update your image locally, simply run docker pull sheogorath/murmur-docker.

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue.

You can also reach the project maintainers via the #Admins IRC channel on MadIRC.

License

Licensed under MIT. View License.


Docker Pull Command
Owner
sheogorath
Source Repository