Variable | Default | Required | Description |
---|---|---|---|
NAME | Valheim Docker |
TRUE | The name of your server! Make it fun and unique! |
WORLD | Dedicated |
TRUE | This is used to generate the name of your world. |
PORT | 2456 |
TRUE | Sets the port your server will listen on. Take not it will also listen on +2 (ex: 2456, 2457, 2458) |
PASSWORD | 12345 |
TRUE | Set this to something unique! |
TZ | America/Los_Angeles |
FALSE | Sets what timezone your container is running on. This is used for timestamps and cron jobs. Click Here for which timezones are valid. |
AUTO_UPDATE | 0 |
FALSE | Set to 1 if you want your container to auto update! This means at 1 am it will update, stop, and then restart your server. |
version: "3"
services:
valheim:
image: mbround18/valheim:latest
ports:
- 2456:2456/udp
- 2457:2457/udp
- 2458:2458/udp
env:
NAME: "Valheim Docker"
WORLD: "Dedicated"
PORT: "2456"
PASSWORD: "something-secret"
TZ: "America/Los_Angeles"
AUTO_UPDATE: "0"
volumes:
- ./valheim/saves:/home/steam/.config/unity3d/IronGate/Valheim
- ./valheim/server:/home/steam/valheim
Odin is a CLI tool utilized for installing, starting, and stopping Valheim servers
- Odin relies on Rust. Please install Rust
- Odin also assumes that you have SteamCMD already installed. Install instructions for SteamCMD.
- If you have the proper build tools installed you should be able to run Odin on any system.
- Current Supported Architecture: Unix & Linux based systems. Windows coming soon.
Make sure you have build essentials installed before you install this crate
cargo install --git https://github.com/mbround18/valheim-docker.git --branch main
odin install
odin start
odin stop
- latest (Stable):
- Readme update to include the versions section and environment variables section.
- 1.1.1 (Stable):
- Includes PR #10 to fix the double world argument.
- 1.1.0 (Stable):
- Includes fix for #3 and #8.
- Improves the script interface and separation of concerns, files now have a respective code file that supports interactions for cleaner development experience.
- Docker image is cleaned up to provide a better usage experience. There is now an
AUTO_UPDATE
feature. - Has a bug where the script has two entries for the world argument.
- 1.0.0 (Stable):
- It works! It will start your server and stop when you shutdown.
- This supports passing in environment variables or arguments to
odin
- Has a bug in which it does not read passed in variables appropriately to Odin. Env variables are not impacted see #3.