From 0d8bab299dbdaee08eafe4d483e5f42e192abdff Mon Sep 17 00:00:00 2001 From: Jan Klass Date: Wed, 10 Apr 2024 18:07:10 +0200 Subject: [PATCH] DOCS(docker): Drop outdated docker compose documentation Docker documentation should be on our website (administrator/hoster documentation) or our [mumble-docker] repository. This repository /docs/ should only contain developer documentation and scoped to this source/main project. --- PR #5838 commit 81bb8f7 removed the docker-compose.yml file in this repository. The `murmur.ini` reference is outdated. It was moved and renamed to `umble-server-ini` The `database` path is outdated ('murmur' name). --- Replaces/Closes PR #6387 which intended to fix the documentation. [mumble-docker]: https://github.com/mumble-voip/mumble-docker/ --- docs/DockerCompose.md | 34 ---------------------------------- 1 file changed, 34 deletions(-) delete mode 100644 docs/DockerCompose.md diff --git a/docs/DockerCompose.md b/docs/DockerCompose.md deleted file mode 100644 index e4ea64a5a..000000000 --- a/docs/DockerCompose.md +++ /dev/null @@ -1,34 +0,0 @@ -# Docker Compose - -## Configuring Murmur - -1. Create a new directory and switch to it. - -2. Create the file `docker-compose.yml` and copy the [default docker-compose.yml](../scripts/docker-compose.yml) into it. - -3. Create the directory `data` and make `1000` its owner. - -4. Create the file `murmur.ini` and copy the [default murmur.ini](../scripts/murmur.ini) into it. - -5. Change `database` in `murmur.ini` to `/var/lib/murmur/murmur.sqlite`. - -6. Run `docker-compose up -d`. Append the `--build` switch to force rebuilding, if needed (e.g. new commits since last build). - -## Viewing the log - -Run `docker logs mumble-server`. - -## Using the release build instead of the master branch - -Change `#master` at the end of the build line in `docker-compose.yml` to the branch you want to compile. For example, `build: github.com/mumble-voip/mumble#1.4.x` will build version `1.4.x`. - -## Adding a certificate - -First, give Murmur permission to read the certificate files. There are two options for this: - -1. Move the certificate files to a location user `1000` can read -2. Have Murmur read the certificate files as `root` and then switch accounts. This is done by adding `user: "0:0"` to `docker-compose.yml` and changing `uname` to `uname=murmur` in `murmur.ini` - -Then add a volume with the certificate files in the `volume` section of `docker-compose.yml`: `- /path/to/certificate-directory/:/certs:ro`. - -Finally, change `sslCert` and `sslKey` in `murmur.ini` to their respective paths and run `docker-compose down` followed by `docker-compose up -d`.