diff --git a/Quick-Start.md b/Quick-Start.md new file mode 100644 index 0000000..89d501d --- /dev/null +++ b/Quick-Start.md @@ -0,0 +1,205 @@ +
+ This page provides a fast, practical guide to deploying and running the + Managed Valheim server container. If you want to get up and + running quickly on TrueNAS SCALE or any OCI-compatible platform, this is the + place to start. +
+ ++ Pull the desired version of the container from your registry: +
+ +gitea.theminisip.ca/mini-server-manager/managed-valheim:1.0.1.1
+
+
+ You may also use latest, but versioned tags are recommended for
+ production deployments.
+
+ The container expects two persistent volumes: +
+ +/config — configuration and runtime metadata/backups — world backup storage+ On TrueNAS SCALE, these map to datasets you select during app installation. +
+ ++ Valheim uses three UDP ports: +
+ +2456/udp
+2457/udp
+2458/udp
+
+
++ TrueNAS SCALE will automatically expose these based on your app configuration. +
+ ++ At minimum, configure the following: +
+ +| Variable | +Default | +Description | +
|---|---|---|
SERVER_NAME |
+ Valheim Server | +Name shown in server browser | +
WORLD_NAME |
+ Dedicated | +World save name | +
SERVER_PASSWORD |
+ changeme | +Password required to join | +
PUBLIC |
+ 1 | +Public listing toggle | +
+ The server includes automated world backups. Configure these variables to + control timing and retention: +
+ +| Variable | +Default | +Description | +
|---|---|---|
BACKUP_INTERVAL |
+ 21600 | +Backup interval (seconds). Default is 6 hours. | +
BACKUP_RETENTION_DAYS |
+ 7 | +Number of days to keep backups before pruning. | +
+ Backups are stored in the /backups volume as timestamped ZIP
+ archives.
+
+ The container automatically updates Valheim on each start: +
+ +/opt/valheim_base./opt/valheim.+ This clean + modded directory separation ensures reliable updates even when + mods are installed. +
+ ++ Once configured, simply start or restart the TrueNAS SCALE app. The server + will: +
+ ++ Logs are visible directly in the TrueNAS SCALE UI. +
+ ++ Mods can be placed in: +
+ +/opt/valheim/BepInEx/plugins
+
++ These files persist across updates because the modded directory is preserved + during the SteamCMD update cycle. +
+ ++ This Quick Start should get your server running in minutes. For deeper + configuration, explore the other wiki pages. +