[Valheim]

Docker

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

Mod Support! It is supported to launch the server with BepInEx but!!!!! as a disclaimer! You take responsibility for debugging why your server won't start. Modding is not supported by the Valheim developers officially yet; Which means you WILL run into errors. This repo has been tested with running ValheimPlus as a test mod and does not have any issues. See [Getting started with mods]

Download Locations

DockerHub

GitHub Container Registry

Environment Variables

See further on down for advanced environment variables.

Docker Compose

Simple

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

Everything but the kitchen sink

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: "Strong! Password @ Here"
      TZ: "America/Chicago"
      PUBLIC: 1
      AUTO_UPDATE: 1
      AUTO_UPDATE_SCHEDULE: "0 1 * * *"
      AUTO_BACKUP: 1
      AUTO_BACKUP_SCHEDULE: "*/15 * * * *"
      AUTO_BACKUP_REMOVE_OLD: 1
      AUTO_BACKUP_DAYS_TO_LIVE: 3
      AUTO_BACKUP_ON_UPDATE: 1
      AUTO_BACKUP_ON_SHUTDOWN: 1
      WEBHOOK_URL: "https://discord.com/api/webhooks/IM_A_SNOWFLAKE/AND_I_AM_A_SECRET"
      UPDATE_ON_STARTUP: 0
    volumes:
      - ./valheim/saves:/home/steam/.config/unity3d/IronGate/Valheim
      - ./valheim/server:/home/steam/valheim
      - ./valheim/backups:/home/steam/backups

[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]

Click here to see advanced environment variables for Odin

BepInEx Support

This repo automatically launches with the proper environment variables for BepInEx. However, you have to install it manually in the container due to the fact that the modding community around Valheim is still in its infancy.

Click Here to view documentation on BepInEx Support

Webhook Support

This repo can automatically send notifications to discord via the WEBHOOK_URL variable. Only use the documentation link below if you want advanced settings!

Click Here to view documentation on Webhook Support

Sponsors

Release Notifications

If you would like to have release notifications tied into your Discord server, click here:

Note: The discord is PURELY for release notifications and any + all permissions involving sending chat messages has been disabled. Any support for this repository must take place on the Discussions.

Versions:

• latest (Stable):
  • [#100] Added backup feature to run based on cronjob.
  • [#148] Added Mod support
  • [#158] Added webhook configuration and documentation updates
  • [#236] Now publish to github registry as well
  • [#276] Advanced mod support with auto installer
• 1.2.0 (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.
  • [#77] Fix auto update not acknowledging variables and added odin to system bin.
  • [#89] Daemonized the server process by using rust specific bindings rather than dropping down to shell.
• 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].

[//]: <> (Github Issues below...........) [#276]: https://github.com/mbround18/valheim-docker/pull/276 [#236]: https://github.com/mbround18/valheim-docker/pull/236 [#158]: https://github.com/mbround18/valheim-docker/pull/158 [#148]: https://github.com/mbround18/valheim-docker/pull/148 [#100]: https://github.com/mbround18/valheim-docker/pull/100 [#89]: https://github.com/mbround18/valheim-docker/pull/89 [#77]: https://github.com/mbround18/valheim-docker/pull/77 [#53]: https://github.com/mbround18/valheim-docker/pull/53 [#35]: https://github.com/mbround18/valheim-docker/issues/24 [#24]: https://github.com/mbround18/valheim-docker/issues/24 [#18]: https://github.com/mbround18/valheim-docker/pull/18 [#11]: https://github.com/mbround18/valheim-docker/issues/11 [#10]: https://github.com/mbround18/valheim-docker/pull/10 [#8]: https://github.com/mbround18/valheim-docker/issues/8 [#3]: https://github.com/mbround18/valheim-docker/issues/3

[//]: <> (Links below...................) [Odin]: ./docs/odin.md [Valheim]: https://www.valheimgame.com/ [Getting started with mods]: ./docs/getting_started_with_mods.md [If you need help figuring out a cron schedule click here]: https://crontab.guru/#0_1___*

[//]: <> (Image Base Url: https://github.com/mbround18/valheim-docker/blob/main/docs/assets/name.png?raw=true)