# mumble

[![Build Status](https://build.coopcloud.tech/api/badges/coop-cloud/mumble/status.svg)](https://build.coopcloud.tech/coop-cloud/mumble)

Low latency, high quality voice chat application.

<!-- metadata -->

* **Maintainer**: [@amras](https://git.coopcloud.tech/amras)
* **Category**: Apps
* **Status**: 3, stable
* **Image**: [mumblevoip/mumble-server](https://hub.docker.com/r/mumblevoip/mumble-server), 4, official
* **Healthcheck**: Yes
* **Backups**: Yes
* **Email**: N/A
* **Tests**: No
* **SSO**: N/A

<!-- endmetadata -->

## Basic usage

1. Set up Docker Swarm and [`abra`]
2. Configure [`coop-cloud/traefik`] to accept mumble's ports:
    ```bash
    $ abra app config <YOURTRAEFIKDOMAIN>
    ```
  - uncomment lines related to mumble:
    ```
    COMPOSE_FILE="$COMPOSE_FILE:compose.mumble.yml"
    MUMBLE_ENABLED=1
    ```
  - save the config and deploy traefik:
    ```bash
    $ abra app deploy <YOURTRAEFIKCOMAIN> --force
    ```
3. `abra app new mumble`
4. `abra app secret generate <YOURAPPDOMAIN> --all`
5. `abra app config <YOURAPPDOMAIN>`
6. `abra app deploy <YOURAPPDOMAIN>`
7. Connect with a [Mumble client] to port 64738 on your domain

## Web Client

An optional browser-based client is available via the `compose.mumbleweb.yml`
overlay. To enable it:
1. `abra app config mumble.example.com` — uncomment the line:
   ```
   COMPOSE_FILE="$COMPOSE_FILE:compose.mumbleweb.yml"
   ```
2. `abra app deploy <YOURAPPDOMAIN> --force`
3. Open `https://<YOURAPPDOMAIN>` in a browser

## Server Password
By default, the server is not password-restricted. To enable a server password,
1. uncomment the relevant lines in the config:
```
COMPOSE_FILE="$COMPOSE_FILE:compose.serverpassword.yml"
SECRET_SERVER_PASSWORD_VERSION=v1
```
2. set the password as a secret:
```bash
$ abra app secret insert <YOURAPPDOMAIN> server-pw v1
? specify secret value:
```
3. Redeploy your app:
```bash
$ abra app deploy <YOURAPPDOMAIN> --force
```

## Host-Port Mode

Instead of modifying the Traefik config,
you can alternatively deploy Mumble with compose.host-ports.yml,
and it will bind directly to the host server port 64738,
bypassing Traefik.

This is not recommended for multinode setups, since the client would have to connect directly to whichever node is running the app container, but this does work when deployed to a single server.

With this compose file, you can deploy mumble without any changes to the Traefik config:

1. `abra app config <YOURAPPDOMAIN>` — uncomment the line:
   ```
   COMPOSE_FILE="$COMPOSE_FILE:compose.host-ports.yml"
   ```
2. `abra app deploy <YOURAPPDOMAIN> --force`

[`abra`]: https://git.coopcloud.tech/coop-cloud/abra
[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
[Mumble client]:(https://www.mumble.info/downloads/)