first commit

2026-07-01 19:54:19 -04:00 · 2022-04-20 23:04:26 +02:00
commit af26f202d4
4 changed files with 191 additions and 0 deletions
@@ -0,0 +1,5 @@
+.git
+.gitignore
+.github
+.gitattributes
+README.md
@@ -0,0 +1,72 @@
+name: Build Vintage Story Docker image
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: "Release type"
+        required: true
+        default: "stable"
+        type: choice
+        options:
+          - stable
+          - unstable
+      version:
+        description: "Game version MAJOR.MINOR.PATCH"
+        required: true
+      minor_version:
+        description: "Game version MAJOR.MINOR (only stable version)"
+        required: false
+
+jobs:
+  build-and-push-docker-image:
+    name: Build Docker image and push to repositories
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build and push (stable)
+        if: ${{ github.event.inputs.release_type == 'stable' }}
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          build-args: |
+            RELEASE_TYPE=${{ github.event.inputs.release_type }}
+            VERSION=${{ github.event.inputs.version }}
+          push: true
+          tags: |
+            ${{ secrets.DOCKER_HUB_USERNAME }}/vintagestory:latest
+            ${{ secrets.DOCKER_HUB_USERNAME }}/vintagestory:${{ github.event.inputs.release_type }}
+            ${{ secrets.DOCKER_HUB_USERNAME }}/vintagestory:${{ github.event.inputs.minor_version }}
+            ${{ secrets.DOCKER_HUB_USERNAME }}/vintagestory:${{ github.event.inputs.version }}
+
+      - name: Build and push (unstable)
+        if: ${{ github.event.inputs.release_type == 'unstable' }}
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          build-args: |
+            RELEASE_TYPE=${{ github.event.inputs.release_type }}
+            VERSION=${{ github.event.inputs.version }}
+          push: true
+          tags: |
+            ${{ secrets.DOCKER_HUB_USERNAME }}/vintagestory:${{ github.event.inputs.release_type }}
+            ${{ secrets.DOCKER_HUB_USERNAME }}/vintagestory:${{ github.event.inputs.version }}
@@ -0,0 +1,21 @@
+# Download files
+FROM alpine:latest AS downloaded
+WORKDIR /downloads
+
+ARG VERSION="1.16.5"
+ARG RELEASE_TYPE="stable"
+
+RUN wget "https://cdn.vintagestory.at/gamefiles/${RELEASE_TYPE}/vs_server_${VERSION}.tar.gz"
+RUN tar xzf "vs_server_${VERSION}.tar.gz"
+RUN rm "vs_server_${VERSION}.tar.gz"
+
+# Run server
+FROM mono:latest AS base
+WORKDIR /vintagestory
+
+COPY --from=downloaded /downloads /vintagestory
+
+VOLUME [ "/vintagestory/data" ]
+
+EXPOSE 42420/tcp
+CMD mono VintagestoryServer.exe --dataPath ./data
@@ -0,0 +1,93 @@
+<div align="center">
+
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/zsuatem/VintageStory-Docker/Build%20Vintage%20Story%20Docker%20image/master?label=image%20build&style=flat-square)
+
+![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/zsuatem/vintagestory/stable?label=latest%20stable%20version&style=flat-square)
+
+![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/zsuatem/vintagestory/unstable?label=latest%20unstable%20version&style=flat-square)
+
+![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/zsuatem/vintagestory?style=flat-square)
+![Docker Pulls](https://img.shields.io/docker/pulls/zsuatem/vintagestory?style=flat-square)
+![Docker Stars](https://img.shields.io/docker/stars/zsuatem/vintagestory?style=flat-square)
+
+</div>
+
+# About
+Simple Docker image of Vintage Story Server for `amd64`, `arm64` and `arm v7` architectures.
+
+# Tags
+- `latest`, `stable` - latest stable version
+  - `1.16` - latest 1.16.x (stable) version e.g. (1.14, 1.15)
+    - `1.16.4` - 1.16.4 (stable) version e.g. (1.14.10, 1.15.2)
+- `unstable` - latest unstable version
+  - `1.16.5-rc.1` - 1.16.5-rc.1 (preview, rc) version e.g. (v1.14.0-pre.11, v1.15.0-pre.8)
+
+# How to use
+## Simple run
+Simple run with default settings (not recommended).
+```docker
+docker run --name vintagestory -d -it -p 42420:42420/tcp zsuatem/vintagestory:latest
+```
+
+## Data folder
+If you want to easily change some settings or add mods you can mount the `data` folder or what you need to folder/file on your server. the `data` folder is mounted to a randomly named volume by default.
+
+The `data` folder contains:
+
+```
+.
+|-- BackupSaves
+|-- Backups
+|-- Cache
+|-- Logs
+|-- Macros
+|-- Mods
+|-- Playerdata
+|-- Saves
+|-- WorldEdit
+|-- serverconfig.json
+`-- servermagicnumbers.json
+```
+
+If you do not want to mount any file or folder you can copy the file from the server to the container using `docker cp` e.g. `docker cp ./serverconfig.json vintagestory:/vsserverdata/serverconfig.json`.
+
+## Access to console
+You can easily access the console using `docker attach vintagestory` where "vintagestory" is the container name.
+To detach, use the keyboard shortcut <kbd>Ctrl</kbd> + <kbd>P</kbd> <kbd>Q</kbd>.
+
+## Run the server (docker run)
+Run with the `data` folder in the container mounted to `vsserverdata` volume.
+```docker
+docker run --name vintagestory -d -it \
+    -p 42420:42420/tcp \
+    -v vsserverdata:/vintagestory/data \
+    zsuatem/vintagestory:latest
+```
+
+## Run the server (docker compose)
+Same as above but as `docker-compose.yml`. You can exacly the 
+
+`docker-compose.yml` file:
+```yml
+version: "3.9"
+
+services:
+    vintagestory:
+        image: zsuatem/vintagestory:latest
+        container_name: vintagestory
+        restart: always
+        ports:
+            - 42420:42420/tcp
+        volumes:
+            - vsserverdata:/vintagestory/data
+        stdin_open: true
+        tty: true
+
+volumes:
+        vsserverdata:
+```
+
+# Useful URLs
+Official game site [Vintage Story](https://www.vintagestory.at/)
+
+You can find the images on [Docker Hub](https://hub.docker.com/r/zsuatem/vintagestory)