diff --git a/README.md b/README.md new file mode 100644 index 0000000..e59b6e0 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +Murmur server for [Mumble](https://wiki.mumble.info/wiki/Main_Page). + +# Volumes +- `/var/lib/murmur` +- `/etc/ssl/murmur:ro`: certificates have to be here + +# Environment Variables +## WELCOME_TEXT +Welcome message sent to clients when they connect. + +## SERVER_PASSWORD +Password to join server. + +## PASSWORD_PASSWORD +Password of the SuperUser. + +## MAX_BANDWIDTH +- default: 72000 + +Maximum bandwidth (in bits per second) clients are allowed to send speech at. + +## MAX_USERS +- default: 20 + +Maximum number of concurrent clients allowed. + +## CERT_NAME +- default: fullchain.pem + +Name of the certificate file. + +## KEY_NAME +- default: privkey.pem + +Name of the key file. + +# Ports +- 64738 + +# Capabilities +- DAC_OVERRIDE +- NET_BIND_SERVICE +- SETGID +- SETUID