]> git.deb.at Git - rhonda/impostor.git/commitdiff
[Docs] Add docker-compose instructions (#180)
authorHmmbob <33529490+hmmbob@users.noreply.github.com>
Wed, 25 Nov 2020 06:16:13 +0000 (07:16 +0100)
committerGitHub <noreply@github.com>
Wed, 25 Nov 2020 06:16:13 +0000 (07:16 +0100)
* Add docker-compose instructions

* Remove unused badge

* Add volume mapping

* Add some more volume mappings

* Restore badge

docs/Running-the-server.md

index c578133f2a930187d792607835ed55e5a4ed2c88..5ba71a3b4dfea295ffa69e9ee0e08270c7c80377 100644 (file)
@@ -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.