diff --git a/Home.md b/Home.md index 2f32136..acb9218 100644 --- a/Home.md +++ b/Home.md @@ -1,17 +1,130 @@ - -

Managed Valheim Server — Overview

This project provides a fully automated, self-updating, BepInEx‑patched Valheim dedicated server designed for TrueNAS SCALE and other containerized environments. It includes SteamCMD installation, mod patching, managed startup, and optional world backup automation.

Core Features

SteamCMD Auto‑Install & Auto‑Update

BepInEx Managed Integration

Managed Wrapper (start_server_managed.sh)

World Backup System

TrueNAS SCALE Ready

Directory Layout

-Path | Purpose +

Managed Valheim Server

-- SteamCMD installation -- Valheim server root -- World saves -- Managed backup output -- Main startup script -- Optional standalone backup script -- Managed wrapper +

+ Managed Valheim is a fully automated, self-updating, + BepInEx‑patched Valheim dedicated server designed for TrueNAS SCALE and other + container platforms. It provides a clean SteamCMD installation, reliable mod + integration, and optional world backup automation. +

-

Startup Flow

  1. Container starts → entrypoint.sh runs.

  2. SteamCMD installs/updates Valheim.

  3. BepInEx pack downloaded & patched.

  4. Managed wrapper installed.

  5. Wrapper launches server with correct flags:

  6. Server boots, loads world, begins accepting connections.

Logging

Backup Behavior

Requirements

Known Non-Issues / Safe Warnings

These appear in logs but do not affect server operation:

- \ No newline at end of file +
+ +

What This Project Provides

+ + + +
+ +

Key Environment Variables

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VariableDefaultDescription
SERVER_NAMEValheim ServerDisplay name of the server
WORLD_NAMEDedicatedWorld save name
SERVER_PASSWORDchangemePassword required to join
PUBLIC1Public listing toggle
BACKUP_INTERVAL21600Backup interval (seconds)
BACKUP_RETENTION_DAYS7Days to retain backups
+ +
+ +

How It Works

+ +
    +
  1. Container starts and runs entrypoint.sh.
  2. +
  3. SteamCMD installs or updates Valheim in /opt/valheim_base.
  4. +
  5. Updated binaries are copied into /opt/valheim.
  6. +
  7. BepInEx is downloaded, validated, extracted, and patched.
  8. +
  9. The managed wrapper launches the server with correct parameters.
  10. +
  11. A background loop performs world backups and pruning.
  12. +
+ +
+ +

Directory Layout

+ + + +
+ +

Notes

+ + + +
+ +

+ For detailed configuration, troubleshooting, and modding instructions, see the + other pages in this wiki. +