https://github.com/taylorskalyo/docker-vintagestory
Docker image for Vintage Story
https://github.com/taylorskalyo/docker-vintagestory
docker-image vintage-story
Last synced: 3 months ago
JSON representation
Docker image for Vintage Story
- Host: GitHub
- URL: https://github.com/taylorskalyo/docker-vintagestory
- Owner: taylorskalyo
- License: mit
- Created: 2025-08-03T21:48:29.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-09-10T19:41:05.000Z (11 months ago)
- Last Synced: 2025-09-14T21:38:34.449Z (10 months ago)
- Topics: docker-image, vintage-story
- Language: Shell
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# taylorskalyo/vintagestory
Docker image for Vintage Story based on [linuxserver.io's alpine base image](https://github.com/linuxserver/docker-baseimage-alpine).
> [!WARNING]
> At the moment I have no plans to maintain this image beyond version 1.20.12. If you need older/newer versions consider using one of the other available images. [VSDS](https://github.com/XurxoMF/vsds) seems to have several versions available (though I have not tried any of them).
## Usage
### docker-compose (recommended)
```
---
services:
vintagestory:
image: ghcr.io/taylorskalyo/vintagestory
container_name: vintagestory
environment:
PUID: 1000
PGID: 1000
STARTUP_COMMANDS: "/op "
PLAYERS_WHITELIST: " "
SERVER_PASSWORD: ""
MOD_URLS: "
"
volumes:
- :/config
ports:
- 42420:42420
restart: unless-stopped
```
## Parameters
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
| Parameter | Function |
| :----: | --- |
| `-p 42420` | Vintage Story port |
| `-e PUID=1000` | For UserID - see below for explanation |
| `-e PGID=1000` | For GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | Specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) |
| `-e STARTUP_COMMANDS=` | Run a command when server starts. For example, players without access to the server console can op themselves. Can run multiple commands by separating them with linebreaks. See official [docs](https://wiki.vintagestory.at/Server_Config) |
| `-e SERVER_PASSWORD=` | If not empty, requires a password for players to log in |
| `-e PLAYERS_WHITELIST=` | By default Vintage Story only allows whitelisted players to join |
| `-e MOD_URLS=` | Download mods from the given URLs before starting the server |
| `-v /config` | Persistent config files |