diff --git a/gomuks/installation.md b/gomuks/installation.md index e3e1813..981a461 100644 --- a/gomuks/installation.md +++ b/gomuks/installation.md @@ -67,7 +67,42 @@ Simply pull changes (`git pull`) and run `./build.sh` again to update. ## Docker (gomuks web) The backend for gomuks web can also run in Docker. Docker images are available -at `dock.mau.dev/tulir/gomuks`. +at [dock.mau.dev/tulir/gomuks](https://mau.dev/tulir/gomuks/container_registry/111?sort=desc). Keep in mind that the backend has all your encryption keys, which means it must be ran in a secure location. + +This example mirrors the port and locations used when running the binary directly: +```yaml:docker-compose.yml +services: + gomuks: + image: dock.mau.dev/tulir/gomuks:latest + restart: unless-stopped + ports: + - "29325:29325" + volumes: + - "$HOME/gomuks:/data" +``` + +On the first run, launch interactively to generate the config files: +```bash +docker compose run -it gomuks +``` + +Or use Docker Run: +```bash +docker run -it --rm \ + -p 29325:29325 \ + -v $HOME/gomuks:/data \ + dock.mau.dev/tulir/gomuks:latest +``` + +Once configured, remove the `-it` and use `-d` to have gomuks daemonize, then +access the web interface at `http://localhost:29325`. + +If you are running gomuks on a different machine, or through a reverse proxy, +you may need to edit the listen address in the generated `config.yaml`, e.g. +```yaml:config/config.yaml +web: + listen_address: 0.0.0.0:29325 +```