From dce6e3ecc96e2ccd8b9e60c695450fdab43c07fd Mon Sep 17 00:00:00 2001 From: shim_ Date: Wed, 25 May 2016 23:26:24 +0000 Subject: [PATCH] README.md edited online with Bitbucket --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f20c620 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +## How do I get set up? ## + +###Most basic setup with SQLite### +``` +#!bash + +docker run -p 64738:64738 -p 64738:64738/udp shimun/mumble +``` + +###Or more advanced with MySQL### +``` +#!bash + +docker run -p 64738:64738 -p 64738:64738/udp -e DATABASE=MYSQL -e DB_HOST=127.0.0.1 -e DB_NAME=murmur -e DB_USER= -e DB_PASS= shimun/mumble + +``` +Optional variables to configure MySQL: + +* **DB_PREFIX** defaults to *none*: Prefix for tables generated by murmur + +* **DB_PORT** defaults to *3306*: Port of your MySQL server, 3306 is the MySQL default + + +Other variables to configure Mumble: + +* **SERVER_PASSWORD** defaults to *none*: Password required to enter the server + +* **MAX_USERS** defaults to *unlimited*: Maximum amount of users allowed on the server + +* **SERVER_TEXT** defaults to *Welcome to this server*: Greeting message + +* **REGISTER_NAME** defaults to *Root*: Name of the top level channel + +* **BANDWIDTH** defaults to *72000*: Bandwidth limit for voice data in bit/s + +* **SUPW** defaults to *autogenerated*: Password for the superuser account, you can lookup the *autogenerated* one in this containers logs \ No newline at end of file