mbround18/valheim repository overview

⁠Valheim⁠

⁠Running on Linux Server

This repo bundles its tools in a way that you can run them without having to install docker! If you purely want to run this on a Linux based system, without docker, take a look at the links below <3

• Installing & Using Odin⁠ The tool Odin⁠ runs the show and does almost all the heavy lifting in this repo. It starts, stops, and manages your Valheim server instance.
• Installing & Using Huginn⁠ Looking for a way to view the status of your server? Look no further than Huginn⁠! The Huginn⁠ project is a http server built on the same source as Odin⁠ and uses these capabilities to expose a few http endpoints.

⁠Running with Docker

⁠Download Locations

⁠DockerHub

⁠GitHub Container Registry

⁠Environment Variables

⁠Container Env Variables

⁠Auto Update

Auto update job, queries steam and compares it against your internal steam files for differential in version numbers.

⁠Auto Backup

Auto backup job produces an output of a *.tar.gz file which should average around 30mb for a world that has an average of 4 players consistently building on. You should be aware that if you place the server folder in your saves folder your backups could become astronomical in size. This is a common problem that others have observed, to avoid this please follow the guide for how volume mounts should be made in the docker-compose.yml.

⁠Huginn⁠ Http Server

• /metrics provides a prometheous style metrics output.
• /status provides a more traditional status page.

⁠Docker Compose

⁠Simple

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⁠

⁠How to Transfer Files⁠

This is a tutorial of a recommended path to transfering files. This can be done to transfer world files between hosts, transfer BepInEx configs, or even to transfer backups.

Click Here to view the tutorial of how to transfer files.⁠

⁠Sponsors

Looking for 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): Mod support! and cleaned up the code base.
• 1.4.x (Stable): Webhook for discord upgrade.
• 1.3.x (Stable): Health of codebase improvements.
• 1.2.0 (Stable): Added additional stop features and sig for stopping.
• 1.1.1 (Stable): Patch to fix arguments
• 1.1.0 (Unstable): Cleaned up image and made it faster
• 1.0.0 (Stable): It works!

⁠Contributors ✨

Thanks goes to these wonderful people (emoji key⁠):

Mark⁠ 📖⁠	Michael⁠ 🚇⁠ 💻⁠ 📖⁠	imgbot[bot]⁠ 📖⁠	Jonathan Boudreau⁠ 💻⁠	Lukáš Hruška⁠ 📖⁠	Julian Vallée⁠ 💻⁠	Finomnis⁠ 💻⁠
Justin Byrne⁠ 📖⁠

This project follows the all-contributors⁠ specification. Contributions of any kind welcome!