Add FAQ

the_minisip committed 2026-10-16 13:27:18 -03:00
1 parent b4959f2154
commit d01c1c9ee7
1 file changed
+210
+210
@@ -0,0 +1,210 @@
<h1><strong>Frequently Asked Questions (FAQ)</strong></h1>
<p>
This page answers common questions about installing, running, updating,
modding, and backing up the <strong>Managed Valheim</strong> server. It is
designed to help new users and administrators quickly resolve typical issues.
</p>
<hr>
<h2><strong>General Questions</strong></h2>
<h3><strong>What is Managed Valheim?</strong></h3>
<p>
Managed Valheim is a fully automated, self-updating Valheim dedicated server
container with built-in BepInEx support, modding compatibility, and automated
world backups. It is designed for TrueNAS SCALE and other OCI platforms.
</p>
<h3><strong>Does the server update automatically?</strong></h3>
<p>
Yes. Every time the container starts, SteamCMD installs or updates Valheim in
<code>/opt/valheim_base</code>, then copies updated files into the modded
runtime directory <code>/opt/valheim</code>.
</p>
<h3><strong>Does the server support mods?</strong></h3>
<p>
Yes. BepInEx is installed automatically, and mods can be placed in:
</p>
<pre><code>/opt/valheim/BepInEx/plugins</code></pre>
<hr>
<h2><strong>Installation & Configuration</strong></h2>
<h3><strong>Which volumes are required?</strong></h3>
<ul>
<li><code>/config</code> — configuration and metadata</li>
<li><code>/backups</code> — world backup storage</li>
</ul>
<h3><strong>Which ports need to be exposed?</strong></h3>
<p>
Valheim requires three UDP ports:
</p>
<pre><code>2456/udp
2457/udp
2458/udp
</code></pre>
<h3><strong>Which environment variables are required?</strong></h3>
<p>
At minimum:
</p>
<ul>
<li><code>SERVER_NAME</code></li>
<li><code>WORLD_NAME</code></li>
<li><code>SERVER_PASSWORD</code></li>
<li><code>PUBLIC</code></li>
</ul>
<hr>
<h2><strong>Modding</strong></h2>
<h3><strong>Where do I install mods?</strong></h3>
<p>
Mods go into:
</p>
<pre><code>/opt/valheim/BepInEx/plugins</code></pre>
<h3><strong>Will mods break updates?</strong></h3>
<p>
No. The clean install directory (<code>/opt/valheim_base</code>) is kept
separate from the modded runtime directory (<code>/opt/valheim</code>), so
SteamCMD updates are always safe.
</p>
<h3><strong>Where are mod configuration files stored?</strong></h3>
<p>
Many mods generate configs under:
</p>
<pre><code>/opt/valheim/BepInEx/config</code></pre>
<hr>
<h2><strong>Backups</strong></h2>
<h3><strong>Does the server create backups automatically?</strong></h3>
<p>
Yes. The container creates timestamped ZIP backups at a configurable interval
and prunes old backups based on retention settings.
</p>
<h3><strong>Where are backups stored?</strong></h3>
<p>
Backups are stored in:
</p>
<pre><code>/backups</code></pre>
<h3><strong>Does Valheim create its own backups?</strong></h3>
<p>
Yes. Valheim maintains up to 5 rolling internal backups in:
</p>
<pre><code>/root/.config/unity3d/IronGate/Valheim/worlds_local/&lt;WORLD_NAME&gt;</code></pre>
<p>
These include files like:
</p>
<ul>
<li><code>&lt;WORLD_NAME&gt;.db</code></li>
<li><code>&lt;WORLD_NAME&gt;.fwl</code></li>
<li><code>&lt;WORLD_NAME&gt;_1.db</code></li>
<li><code>&lt;WORLD_NAME&gt;_2.db</code></li>
<li><code>&lt;WORLD_NAME&gt;_3.db</code></li>
<li><code>&lt;WORLD_NAME&gt;_4.db</code></li>
<li><code>&lt;WORLD_NAME&gt;_5.db</code></li>
</ul>
<hr>
<h2><strong>Restoring Worlds</strong></h2>
<h3><strong>How do I restore from a container backup?</strong></h3>
<ol>
<li>Stop the TrueNAS SCALE app.</li>
<li>Extract the ZIP file from <code>/backups</code>.</li>
<li>Copy the world directory into:<br>
<code>/root/.config/unity3d/IronGate/Valheim/worlds_local/&lt;WORLD_NAME&gt;</code>
</li>
<li>Start the app.</li>
</ol>
<h3><strong>How do I restore from Valheim’s internal backups?</strong></h3>
<ol>
<li>Stop the app.</li>
<li>Choose one of the numbered <code>_X.db</code> files.</li>
<li>Replace the main <code>.db</code> and <code>.fwl</code> files.</li>
<li>Start the app.</li>
</ol>
<hr>
<h2><strong>Connectivity</strong></h2>
<h3><strong>Why can't players join?</strong></h3>
<ul>
<li>Check firewall rules for UDP 2456–2458.</li>
<li>Verify the server password.</li>
<li>Ensure <code>PUBLIC=1</code> if using public listing.</li>
</ul>
<h3><strong>Why doesn't the server appear in the browser?</strong></h3>
<ul>
<li>Public listing may take time to propagate.</li>
<li>Use direct connect via IP and port.</li>
<li>Check NAT or port forwarding.</li>
</ul>
<hr>
<h2><strong>Performance</strong></h2>
<h3><strong>Why is the server lagging?</strong></h3>
<ul>
<li>Too many mods or heavy plugins.</li>
<li>Insufficient RAM or CPU on the host.</li>
<li>Mod conflicts causing errors in BepInEx logs.</li>
</ul>
<hr>
<h2><strong>Updates</strong></h2>
<h3><strong>Do I need to manually update the server?</strong></h3>
<p>
No. SteamCMD updates Valheim automatically on each container start.
</p>
<h3><strong>Do I need to update BepInEx manually?</strong></h3>
<p>
No. The container downloads and installs the latest BepInEx pack automatically.
</p>
<hr>
<h2><strong>Next Steps</strong></h2>
<ul>
<li><a href="Home">Home</a></li>
<li><a href="Quick Start">Quick Start</a></li>
<li><a href="Installation">Installation</a></li>
<li><a href="Modding Guide">Modding Guide</a></li>
<li><a href="Backup & Restore">Backup & Restore</a></li>
<li><a href="Troubleshooting">Troubleshooting</a></li>
<li><a href="Version History">Version History</a></li>
</ul>
<p>
This FAQ will expand as new features and versions are released.
</p>