Valheim

Docker

If you are looking for a guide on how to get started click here

Environment Variables

Variable	Default	Required	Description
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.
PUID	`1000`	FALSE	Sets the User Id of the steam user.
PGID	`1000`	FALSE	Sets the Group Id of the steam user.
PORT	`2456`	TRUE	Sets the port your server will listen on. Take not it will also listen on +2 (ex: 2456, 2457, 2458)
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.
PUBLIC	`1`	FALSE	Sets whether or not your server is public on the server list.
PASSWORD	`12345`	TRUE	Set this to something unique!
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.
AUTO_UPDATE_SCHEDULE	`0 1 * * *`	FALSE	This works in conjunction with `AUTO_UPDATE` and sets the schedule to which it will run an auto update. If you need help figuring out a cron schedule click here

Docker Compose

This is a basic example of a docker compose, you can apply any of the variables above to the environment section below but be sure to follow each variables description notes!

version: "3"
services:
  valheim:
    image: mbround18/valheim:latest
    ports:
      - 2456:2456/udp
      - 2457:2457/udp
      - 2458:2458/udp
    environment:
      - PORT=2456
      - NAME="Created With Valheim Docker"
      - WORLD="Dedicated"
      - PASSWORD="Banana Phone"
      - TZ=America/Chicago
      - PUBLIC=1
    volumes:
    - ./valheim/saves:/home/steam/.config/unity3d/IronGate/Valheim
    - ./valheim/server:/home/steam/valheim

Odin

This repo has a CLI tool called Odin in it! It is used for managing the server inside the container. If you are looking for instructions for it click here: Odin

Versions:

latest (Stable):
- Readme update to include the versions section and environment variables section.
- #18 Changed to root as the default user to allow updated steams User+Group IDs.
- #18 Fixed issue with the timezone not persisting.
- To exec into the container you now have to include the -u|--user argument to access steam directly. Example docker-compose exec --user steam valheim bash
- There is now a dry-run command argument on odin to preview what the command would do.
- You can run with -d|--debug to get verbose logging of what odin is doing.
- #11 Added check for length of password and fail on odin install or odin stop failures.
- #24 Added public variable to dockerfile and odin
- #35 Fix for the server to now utilizing SIGINT YOU WILL HAVE TO MANUALLY STOP YOUR SERVER; use pidof valheim_server.x86_64 to get the pid and then kill -2 $pid but replace pid with the pid from pidof
- #53 Formatted scripts to be more useful and added timezone scheduling.
1.1.1 (Stable):
- Includes PR #10 to fix the double world argument.
1.1.0 (Stable):
- Includes a 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 shut down.
- 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.