Add Quick Start
the_minisip committed
1 parent
4064eddff9
commit
02c26e0607
1 file changed
+205
+205
@@ -0,0 +1,205 @@
|
|||||||
|
<h1><strong>Quick Start</strong></h1>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This page provides a fast, practical guide to deploying and running the
|
||||||
|
<strong>Managed Valheim</strong> 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.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>1. Pull the Container Image</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Pull the desired version of the container from your registry:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<pre><code>gitea.theminisip.ca/mini-server-manager/managed-valheim:1.0.1.1</code></pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
You may also use <code>latest</code>, but versioned tags are recommended for
|
||||||
|
production deployments.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>2. Required Volumes</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The container expects two persistent volumes:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><code>/config</code> — configuration and runtime metadata</li>
|
||||||
|
<li><code>/backups</code> — world backup storage</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
On TrueNAS SCALE, these map to datasets you select during app installation.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>3. Required Ports</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Valheim uses three UDP ports:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<pre><code>2456/udp
|
||||||
|
2457/udp
|
||||||
|
2458/udp
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
TrueNAS SCALE will automatically expose these based on your app configuration.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>4. Core Environment Variables</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
At minimum, configure the following:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Variable</th>
|
||||||
|
<th>Default</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>SERVER_NAME</code></td>
|
||||||
|
<td>Valheim Server</td>
|
||||||
|
<td>Name shown in server browser</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>WORLD_NAME</code></td>
|
||||||
|
<td>Dedicated</td>
|
||||||
|
<td>World save name</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>SERVER_PASSWORD</code></td>
|
||||||
|
<td>changeme</td>
|
||||||
|
<td>Password required to join</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>PUBLIC</code></td>
|
||||||
|
<td>1</td>
|
||||||
|
<td>Public listing toggle</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>5. Backup Configuration</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The server includes automated world backups. Configure these variables to
|
||||||
|
control timing and retention:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Variable</th>
|
||||||
|
<th>Default</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>BACKUP_INTERVAL</code></td>
|
||||||
|
<td>21600</td>
|
||||||
|
<td>Backup interval (seconds). Default is 6 hours.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>BACKUP_RETENTION_DAYS</code></td>
|
||||||
|
<td>7</td>
|
||||||
|
<td>Number of days to keep backups before pruning.</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Backups are stored in the <code>/backups</code> volume as timestamped ZIP
|
||||||
|
archives.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>6. How Updates Work</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The container automatically updates Valheim on each start:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li>SteamCMD installs/updates Valheim into <code>/opt/valheim_base</code>.</li>
|
||||||
|
<li>Updated files are copied into <code>/opt/valheim</code>.</li>
|
||||||
|
<li>BepInEx is downloaded, validated, extracted, and patched.</li>
|
||||||
|
<li>The managed wrapper launches the server.</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This clean + modded directory separation ensures reliable updates even when
|
||||||
|
mods are installed.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>7. Starting the Server</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Once configured, simply start or restart the TrueNAS SCALE app. The server
|
||||||
|
will:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Update itself</li>
|
||||||
|
<li>Install BepInEx</li>
|
||||||
|
<li>Apply patches</li>
|
||||||
|
<li>Begin automated backups</li>
|
||||||
|
<li>Launch the Valheim dedicated server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Logs are visible directly in the TrueNAS SCALE UI.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>8. Modding</strong></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Mods can be placed in:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<pre><code>/opt/valheim/BepInEx/plugins</code></pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
These files persist across updates because the modded directory is preserved
|
||||||
|
during the SteamCMD update cycle.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><strong>Next Steps</strong></h2>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="Home">Home</a> — High-level overview</li>
|
||||||
|
<li><a href="Modding">Modding Guide</a></li>
|
||||||
|
<li><a href="Backups">Backup & Restore</a></li>
|
||||||
|
<li><a href="Troubleshooting">Troubleshooting</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This Quick Start should get your server running in minutes. For deeper
|
||||||
|
configuration, explore the other wiki pages.
|
||||||
|
</p>
|
||||||
Reference in new issue
Block a user