Deploy code docs to GitHub Pages for Travis build 3350

Commit: ed4b485cc2
This commit is contained in:
tgstation-server
2020-05-24 22:42:00 +00:00
parent 8d1bbf7559
commit f3da313336
2 changed files with 4 additions and 1 deletions
File diff suppressed because one or more lines are too long
+3
View File
@@ -121,6 +121,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<h4>Docker (Linux)</h4>
<p>tgstation-server supports running in a docker container and is the recommended deployment method for Linux systems. The official image repository is located at <a href="https://hub.docker.com/r/tgstation/server">https://hub.docker.com/r/tgstation/server</a>. It can also be built locally by running <code>docker build . -f build/Dockerfile -t &lt;your tag name&gt;</code> in the repository root.</p>
<p>To create a container run </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;docker run \</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; -ti \ #start interactive for manual configuration</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; --restart=always \ #if you want maximum uptime</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; --network=&quot;host&quot; \ #if your sql server is on the same machine</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; --name=&quot;tgs&quot; \ #or whatever else you wanna call it</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; --cap-add=sys_nice \ #allows tgs to schedule DreamDaemon as a higher priority process</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; --init \ #reaps potential zombie processes</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; -p &lt;tgs port&gt;:80 \</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; -p 0.0.0.0:&lt;public game port&gt;:&lt;public game port&gt; \</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; -v /path/to/your/configfile/directory:/config_data \ #only if you want to use manual configuration</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; -v /path/to/store/instances:/tgs4_instances \</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; -v /path/to/your/log/folder:/tgs_logs \</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; tgstation/server:&lt;release version&gt; #replace this with &lt;your tag name&gt; if you built the image locally</div></div><!-- fragment --><p> with any additional options you desire (i.e. You'll have to expose more game ports in order to host more than one instance).</p>
<ul>
<li>Important note about port exposure: The internal port used by DreamDaemon _**MUST**_ match the port you want users to connect on. If it doesn't, you'll still be able to have them connect HOWEVER links from the BYOND hub will point at what DreamDaemon thinks the port is.</li>
</ul>
<p>Note although <code>/app/lib</code> is specified as a volume mount point in the <code>Dockerfile</code>, unless you REALLY know what you're doing. Do not mount any volumes over this for fear of breaking your container.</p>
<p>The configuration option <code>General:ValidInstancePaths</code> will be preconfigured to point to <code>/tgs4_instances</code>. It is recommended you don't change this.</p>
<p>Note that this container is meant to be long running. Updates are handled internally as opposed to at the container level.</p>