Skip to content

Commit

Permalink
docs: Add Docker docs docker.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kissaki committed Mar 12, 2024
1 parent b80ad2b commit b5af8d0
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ is done by linking the configuration in modules-available to the

An official docker image is available at https://hub.docker.com/r/mumblevoip/mumo.

More information in [docker.md](docker.md).

## Modules for Mumble moderator

### Included modules
Expand Down
47 changes: 47 additions & 0 deletions docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Mumo Docker Image

[Docker](https://en.wikipedia.org/wiki/Docker_(software)) is a containerization and virtualization of applications and application environments.

An official docker image is available at https://hub.docker.com/r/mumblevoip/mumo.

## Network access to Mumble

Mumo accesses Mumble via the Ice interface. If you run Mumble Server in a docker container too, a network_mode configuration needs to be added so Mumo can access it.

If you are connecting to a non-containerized/generally-accessible Mumble Server this is not necessary.

The target is configured in `mumo.ini` with `host` and `port`.

## Data Volume - Configuration

`/data` is a Docker volume. You can bind your own folder to it for configuration and enabling and adding additional Mumo modules.

## Changing Enabled/Loaded Modules

When you add/enable new modules you need the restart the container.

## Running the Mumo Docker Image

The Mumo docker image can be run with:

```
docker run --name mumo --net=container:<id_of_mumble_server_container> -d -v /path/to/mumo/folder:/data mumblevoip/mumo
```

## Docker Compose

[Docker Compose](https://docs.docker.com/compose/) allows you to configure and run multi-container applications. This is useful to run a Mumble and Mumo container in a connected manner.

A docker-compose(v2.4) example:

```
mumble-mumo:
image: mumblevoip/mumo
container_name: mumble-mumo
restart: on-failure
volumes:
- /path/to/mumo/folder:/data
network_mode : "service:mumble-server"
depends_on:
- mumble-server
```

0 comments on commit b5af8d0

Please sign in to comment.