Valheim

Games
Report Issue

A brutal exploration and survival game for 1-10 players, set in a procedurally-generated purgatory inspired by viking culture.

Contributors:
danielb@purpleflaghosting.com
README

Valheim

A brutal exploration and survival game for 1-10 players, set in a procedurally-generated purgatory inspired by viking culture. Battle, build, and conquer your way to a saga worthy of Odin’s patronage!

https://store.steampowered.com/app/892970/Valheim/

Server Ports

Port default
Game 2456
Query 2457
Docker Images (1)
Name Image
ghcr.io/ptero-eggs/games:valheim ghcr.io/ptero-eggs/games:valheim
Startup Command 
./valheim_server.x86_64 -nographics -batchmode -name "{{SERVER_NAME}}" -port {{SERVER_PORT}} -world "{{WORLD}}" -password "{{PASSWORD}}" -public {{PUBLIC_SERVER}} -saveinterval {{BACKUP_INTERVAL}} -backups {{BACKUP_COUNT}} -backupshort {{BACKUP_SHORTTIME}} -backuplong {{BACKUP_LONGTIME}} $( [[ {{ENABLE_CROSSPLAY}} -eq 1 ]] && echo " -crossplay ") > >(sed -uE "{{CONSOLE_FILTER}}") & trap "{{STOP}}" 15; wait $!
Variables (16)

Server Name

Name that appears in server browser.

Environment:
SERVER_NAME
Default:
My Server
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:60

Server Password

Server password.

Environment:
PASSWORD
Default:
secret
User Viewable:
❌
User Editable:
❌
Rules:
required|string|min:5|max:20

World Name

Name to load if switching between multiple saved worlds.

Environment:
WORLD
Default:
Dedicated
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20

Public Server

Public visibility of your server. Set it to false to make the server invisible and only joinable via the 'Join IP'-button.

Environment:
PUBLIC_SERVER
Default:
1
User Viewable:
❌
User Editable:
❌
Rules:
boolean

App ID

Valheim steam app id for auto updates.

Environment:
SRCDS_APPID
Default:
896660
User Viewable:
❌
User Editable:
❌
Rules:
nullable|numeric

LD Library Path

Required to load server libraries.

Environment:
LD_LIBRARY_PATH
Default:
./linux64
User Viewable:
❌
User Editable:
❌
Rules:
required|string

Shutdown Command

Commands to trigger a server shutdown.

Environment:
STOP
Default:
kill -2 $!; wait;
User Viewable:
❌
User Editable:
❌
Rules:
required|string

Auto Update

Enable automatic updates.

Environment:
AUTO_UPDATE
Default:
1
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Enable Crossplay

Enable crossplay support.

Environment:
ENABLE_CROSSPLAY
Default:
1
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Backup Interval

Change how often the world will save in seconds. Default: 1800 (30 minutes).

Environment:
BACKUP_INTERVAL
Default:
1800
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|min:0

Backup Count

Sets how many automatic backups will be kept. The first is the 'short' backup length, and the rest are the 'long' backup length. When default values are used means one backup that is 2 hours old, and 3 backups that are 12 hours apart. Default: 4.

Environment:
BACKUP_COUNT
Default:
4
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|min:0

Backup Shorttime

Sets the interval between the first automatic backups in seconds. Default: 7200 (2 hours).

Environment:
BACKUP_SHORTTIME
Default:
7200
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|min:0

Backup Longtime

Sets the interval between the subsequent automatic backups in seconds. Default: 43200 (12 hours).

Environment:
BACKUP_LONGTIME
Default:
43200
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|min:0

Beta Branch

Beta branch of a steam app. Leave blank to install normal branch.

Environment:
SRCDS_BETAID
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
max:30

Beta Password

Password for a beta branch should one be required during private or closed testing phases. Leave blank for no password.

Environment:
SRCDS_BETAPASS
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
max:30

Console Filter

Remove unwanted outputs from the console.

Environment:
CONSOLE_FILTER
Default:
/^\(Filename:.*Line:[[:space:]]+[[:digit:]]+\)$/d; /^([[:space:]]+)?$/d
User Viewable:
❌
User Editable:
❌
Rules:
string
Installation Script
Container: ghcr.io/ptero-eggs/installers:debian
Entrypoint: bash
#!/bin/bash
# steamcmd Base Installation Script
#
# Server Files: /mnt/server
# Image to install with is 'ghcr.io/ptero-eggs/installers:debian'

##
#
# Variables
# STEAM_USER, STEAM_PASS, STEAM_AUTH - Steam user setup. If a user has 2fa enabled it will most likely fail due to timeout. Leave blank for anon install.
# WINDOWS_INSTALL - if it's a windows server you want to install set to 1
# SRCDS_APPID - steam app id found here - https://developer.valvesoftware.com/wiki/Dedicated_Servers_List
# SRCDS_BETAID - beta branch of a steam app. Leave blank to install normal branch
# SRCDS_BETAPASS - password for a beta branch should one be required during private or closed testing phases.. Leave blank for no password.
# INSTALL_FLAGS - Any additional SteamCMD  flags to pass during install.. Keep in mind that steamcmd auto update process in the docker image might overwrite or ignore these when it performs update on server boot.
# AUTO_UPDATE - Adding this variable to the egg allows disabling or enabling automated updates on boot. Boolean value. 0 to disable and 1 to enable.
#
 ##

# Install packages. Default packages below are not required if using our existing install image thus speeding up the install process.
apt -y update
apt -y --no-install-recommends install curl lib32gcc-s1 ca-certificates

## just in case someone removed the defaults.
if [[ "${STEAM_USER}" == "" ]] || [[ "${STEAM_PASS}" == "" ]]; then
    echo -e "steam user is not set.\n"
    echo -e "Using anonymous user.\n"
    STEAM_USER=anonymous
    STEAM_PASS=""
    STEAM_AUTH=""
else
    echo -e "user set to ${STEAM_USER}"
fi

## download and install steamcmd
cd /tmp
mkdir -p /mnt/server/steamcmd
curl -sSL -o steamcmd.tar.gz https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz
tar -xzvf steamcmd.tar.gz -C /mnt/server/steamcmd
mkdir -p /mnt/server/steamapps # Fix steamcmd disk write error when this folder is missing
cd /mnt/server/steamcmd

# SteamCMD fails otherwise for some reason, even running as root.
# This is changed at the end of the install process anyways.
chown -R root:root /mnt
export HOME=/mnt/server

## install game using steamcmd
./steamcmd.sh +force_install_dir /mnt/server +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} $( [[ "${WINDOWS_INSTALL}" == "1" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} $( [[ -z ${SRCDS_BETAID} ]] || printf %s "-beta ${SRCDS_BETAID}" ) $( [[ -z ${SRCDS_BETAPASS} ]] || printf %s "-betapassword ${SRCDS_BETAPASS}" ) ${INSTALL_FLAGS} validate +quit ## other flags may be needed depending on install. looking at you cs 1.6

## set up 32 bit libraries
mkdir -p /mnt/server/.steam/sdk32
cp -v linux32/steamclient.so ../.steam/sdk32/steamclient.so

## set up 64 bit libraries
mkdir -p /mnt/server/.steam/sdk64
cp -v linux64/steamclient.so ../.steam/sdk64/steamclient.so