diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..127aa88 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2016 Chris Kankiewicz + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index a99a9d7..573b7c3 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ Docker image for Mumble server. [![](https://images.microbadger.com/badges/image/phlak/mumble.svg)](http://microbadger.com/#/images/phlak/mumble "Get your own image badge on microbadger.com") - -### Running the container +Running the Container +--------------------- In order to persist configuration data when upgrading your container you should create a named data volume. This is not required but is _highly_ recommended. @@ -19,13 +19,13 @@ the data-only container: docker run -d -p 64738:64738 -p 64738:64738/udp -v mumble-data:/etc/mumble --name mumble-server phlak/mumble -##### Optional 'docer run' arguments +#### Optional 'docker run' arguments `--restart always` - Always restart the container regardless of the exit status. See the Docker [restart policies](https://goo.gl/OI87rA) for additional details. - -##### Get/set the SuperUser password +Get/Set the SuperUser Password +------------------------------ After starting your container, you can get the randomly generated SuperUser password with: @@ -39,8 +39,8 @@ Manually set a new SuperUser password with: **NOTE:** This can be run at any time to update the SuperUser password - -##### Edit the config +Edit the Config +--------------- Once you have a running container, you can edit the config with: @@ -50,25 +50,12 @@ After saving changes, restart your container: docker restart mumble-server +Troubleshooting +--------------- ------ - -**Copyright (c) 2016 Chris Kankewicz ** - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Please report bugs to the [GitHub Issue Tracker](https://github.com/PHLAK/docker-mumble/issues). -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +Copyright +--------- -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +This project is liscensed under the [MIT License](https://github.com/PHLAK/docker-mumble/blob/master/LICENSE).