From ccedd771622a1745b2bd80a9bbb18161e48bc896 Mon Sep 17 00:00:00 2001 From: Hmmbob <33529490+hmmbob@users.noreply.github.com> Date: Wed, 25 Nov 2020 07:16:13 +0100 Subject: [PATCH] [Docs] Add docker-compose instructions (#180) * Add docker-compose instructions * Remove unused badge * Add volume mapping * Add some more volume mappings * Restore badge --- docs/Running-the-server.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/Running-the-server.md b/docs/Running-the-server.md index c578133..5ba71a3 100644 --- a/docs/Running-the-server.md +++ b/docs/Running-the-server.md @@ -18,12 +18,28 @@ There are currently two modes to run the Impostor server in. The first way is th ### Using docker [![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor?sort=semver)](https://hub.docker.com/repository/docker/aeonlucid/impostor) -[![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor/edge)](https://hub.docker.com/repository/docker/aeonlucid/impostor) +[![Docker Image](https://img.shields.io/docker/v/aeonlucid/impostor/nightly)](https://hub.docker.com/repository/docker/aeonlucid/impostor) ``` docker run -p 22023:22023/udp aeonlucid/impostor:nightly ``` +### Using docker-compose +``` +version: '3.4' + +services: + impostor: + image: aeonlucid/impostor:nightly + container_name: impostor + ports: + - 22023:22023/udp + volumes: + - /path/to/local/config.json:/app/config.json # For easy editing of the config + - /path/to/local/plugins:/app/plugins # Only needed if using plugins + - /path/to/local/libraries:/app/libraries # Only needed if using external libraries +``` + ## Multiple servers Follow the steps from the single server on two or more servers. -- 2.39.5