diff --git a/README.md b/README.md index bce5b07..d5723ce 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,45 @@ # VintageStory Docker Container -this is a simple Docker Container for running a VintageStory server on amd64 \ No newline at end of file +this is a simple container for running a VintageStory server on amd64/linux system + +# Usage + +``` +# clone the repo +git clone https://git.protron.dev/Doc/vintagecontainer.git + +# cd into the directory +cd vintavintagecontainer + +# start the container +sudo docker compose up -d +``` + +You can adjust and add stuff by editing the docker-compose.yml file. + +# Build yourself or different Version +If you want to build the image yourself or you need a different server version, you can do this by: + +``` +# cloning the repo +git clone https://git.protron.dev/Doc/vintagecontainer.git + +# cd into the directory +cd vintagecontainer + +# edting the Dockefile +vim Dockerfile +``` + +To change the server version, edit the VERSION ARG: + +Example: +``` +ARG VERSION="1.19.8" ==> VERSION="1.18.8" +``` + +And than build the image with + +``` +sudo docker build -t {USERNAME}/{IMAGENAME} . +``` \ No newline at end of file