gp3t1/umurmur repository overview

⁠umurmur

umurmur⁠ mumble server, alpine based, expose base configuration at runtime

⁠Installation

1. Make sure you've installed docker
2. Run your custom umurmur instance using the following commands

⁠Usage

Here's a short explanation how to use umurmur:

• Run it with defaults parameters: This will create a new instance with no password and no admin access, exposed on your host on port 64738(TCP/UDP)

  docker run -ti -p 64738:64738 -p 64738:64738/udp umurmur:0.1
  

  Copy

• If you want to customize your umurmur instance:

  • If you want to set a password:

  docker run -ti -p 64738:64738 -p 64738:64738/udp -e PASSWORD=<my-password> umurmur:0.1
  

  Copy
  • You can pass basic umurmur settings in the same way.

  docker run -ti -p 64738:64738 -p 64738:64738/udp [-e VAR1=<my-value> [-e VAR2=<my-value> [-e VAR3=<my-value> [...]]]] umurmur:0.1
  

  Copy

  Supported umurmur settings (and default values):

    - LISTEN4 ("" listen on any IP v4 interface)
    - LISTEN6 ("" listen on any IP v6 interface)
    - PASSWORD ("" no password)
    - ADMIN_PASSWORD ("" no admin access)
    - MAX_USERS (10)
    - SHOW_IPS (true)
    - ENABLE_BAN (true)
    - SYNC_BAN (true)
    - BAN_SECONDS (0)
    - MAX_BANDWIDTH (48000)
    - OPUS_THRESHOLD (100)
    - MOTD "Welcome to umurmur server$(hostname -f)!"
    - ALLOW_TEXT (true)
    - LOGGING (false)
  

  Copy
  • You can also change user and group id for the user running umurmur

  docker run -ti -p 64738:64738 -p 64738:64738/udp -e APP_UID=500 -e APP_GUID=1000 umurmur:0.1
  

  Copy
  • Provide your own let's encrypt certificate files

  docker run -ti -p 64738:64738 -p 64738:64738/udp -v <your-certificates-folder>:/etc/umurmur/cert umurmur:0.1
  

  Copy

  The default umurmur configuration will look for files named fullchain.pem and privkey.pem (based on let's encrypt certificate files) To override the filenames, you can use env variables CERT_NAME and KEY_NAME:

  docker run -ti -p 64738:64738 -p 64738:64738/udp -v <your-certificates-folder>:/etc/umurmur/cert -e CERT_NAME=<my-cert.pem> -e KEY_NAME=<my-privkey.pem> umurmur:0.1
  

  Copy
  • Expose logs folder if you enable logging

  docker run -ti -p 64738:64738 -p 64738:64738/udp -e LOGGING=true -v <your-logs-dir-on-host>:/var/log umurmur:0.1
  

  Copy

⁠Contributing

1. Fork it
2. Create your feature branch: git checkout -b feature/my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin feature/my-new-feature
5. Submit a pull request

⁠Requirements / Dependencies

• docker

⁠Version

0.1

⁠License

Copyright (C) <2017>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/⁠.