From 8065eab0c03b5a637a8342941d8ca474f7063101 Mon Sep 17 00:00:00 2001 From: Maik Laschober Date: Tue, 18 Aug 2020 07:57:36 +0200 Subject: [PATCH] moved custom docker README to main README --- README.md | 51 ++++++++++++++++++++++++++++++++++ build-custom-example/README.md | 16 ----------- 2 files changed, 51 insertions(+), 16 deletions(-) delete mode 100644 build-custom-example/README.md diff --git a/README.md b/README.md index c95b4c2..040c19e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,54 @@ # Run this image To run this image you can use `docker run -pd 42420:42420 --name VintageStoryServer devidian/vintagestory`, but you may want to use a customized version for your needs so see `./build-custom-example/README.md` +# Custom build +You can either copy files from `https://github.com/Devidian/docker-vintagestory/tree/master/build-custom-example` or follow these steps: + +- create a `serverconfig.json` with your settings +- create a `Dockerfile` file with contents found below (maybe adjust port) +- create a `docker-compose.yml` file with contents found below +- run `docker-compose up -d` to start +- run `docker-compose up -d --build` to rebuild and restart +- run `docker-compose down` to stop + +## Dockerfile for custom-build + +```docker +# ============== runtime stage ================== +FROM devidian/vintagestory:latest as runtime + +WORKDIR /game + +ENV VSDATAPATH vs-custom + +# update with your own serverconfig +COPY "./serverconfig.json" "/gamedata/${VSDATAPATH}/serverconfig.json" + +# Expose ports +EXPOSE 42420/tcp + +# CMD [ "mono" , "VintagestoryServer.exe", "--dataPath", "/gamedata/${VSDATAPATH}" ] +CMD mono VintagestoryServer.exe --dataPath "/gamedata/${VSDATAPATH}" + +``` + +## docker-compose.yml + +```yml +version: '3.1' + +services: + vsserver: + build: . + container_name: vsserver + restart: always + volumes: + - gamedata:/gamedata + ports: + - "42420:42420" +volumes: + gamedata: +``` + +# using unstable versions +to use unstable versions just replace tag `latest` with `unstable` in `Dockerfile` \ No newline at end of file diff --git a/build-custom-example/README.md b/build-custom-example/README.md deleted file mode 100644 index c22232c..0000000 --- a/build-custom-example/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Create custom docker image -You can use this `Dockerfile` to create your own serverconfig using `devidian/vintagestory` as base. Just edit serverconfig.json and run `docker build -t YOUR_IMAGE_NAME`. You may also add / override additional files like mods. - -## Run custom docker image -to run the image you can either use `docker run -pd 42420:42420 --name VintageStoryServer YOUR_IMAGE_NAME` or use the composer file as follows. - -```bash -cd run; - -#start -docker-compose up -d -#rebuild / update -docker-compose up -d --build -#stop -docker-compose down -``` \ No newline at end of file