Guide: Add docker variant
This commit is contained in:
parent
9903058750
commit
74da1af12f
119
guide.php
119
guide.php
@ -9,30 +9,57 @@
|
||||
<body data-bs-theme="dark">
|
||||
<?php require "_components/navbar.php"; ?>
|
||||
<div class="container mt-3">
|
||||
<h2>Server Prerequisites</h2>
|
||||
<ul>
|
||||
<li>Git (<a href="https://git-scm.com/downloads" target="_blank">Download</a>)</li>
|
||||
<li>Node.js (<a href="https://nodejs.org/en/download" target="_blank">Download</a></a>)</li>
|
||||
<li>MongoDB (<a href="https://www.mongodb.com/try/download/community" target="_blank">Download</a></a>)</li>
|
||||
</ul>
|
||||
<h2>Server Installation</h2>
|
||||
<ol>
|
||||
<li>Run <code>git clone https://openwf.io/SpaceNinjaServer.git</code> in a command prompt to download SpaceNinjaServer in the current working directory</li>
|
||||
<li>Open the SpaceNinjaServer folder (<code>cd SpaceNinjaServer</code>)</li>
|
||||
<li>Copy config-vanilla.json to create a config.json</li>
|
||||
<li>(Optional) Edit the config.json to match your MongoDB settings (if not default) and however else you would like to configure the server</li>
|
||||
<li>(Optional) If you have a GB of free space, you might want to download stripped assets such as <abbr title="Ability videos show a brief clip of an ability in action. They can be seen by hovering over an ability in the Arsenal, Codex, etc.">ability videos</abbr> so the client can request them on-demand: Run <code>git clone https://openwf.io/0.git</code> in the <code>static/data</code> folder</li>
|
||||
<li>Run <code>npm install --omit=dev --omit=optional</code> to install library dependencies</li>
|
||||
<li>Now you can run <code>npm run raw</code> to start the server anytime</li>
|
||||
</ol>
|
||||
<h2>Server Update</h2>
|
||||
<p>You can simply run the <code>UPDATE AND START SERVER</code> script for this, but otherwise the steps are pretty simple:</p>
|
||||
<ol>
|
||||
<li>Run <code>git pull</code> in the SpaceNinjaServer folder</li>
|
||||
<li>(Optional) If you have the stripped assets, run <code>git pull</code> in the <code>static/data/0</code> folder</li>
|
||||
<li>Run <code>npm install --omit=dev --omit=optional</code> to synchronize library dependencies</li>
|
||||
<li>Now you can use <code>npm run raw</code> to start the server again</li>
|
||||
</ol>
|
||||
<h2>Guide Settings</h2>
|
||||
<div class="form-check mb-3">
|
||||
<input class="form-check-input" type="checkbox" id="docker-toggle" />
|
||||
<label class="form-check-label" for="docker-toggle">Use Docker</label>
|
||||
</div>
|
||||
<div id="web-server-guide">
|
||||
<h2>Server Prerequisites</h2>
|
||||
<ul>
|
||||
<li>Git (<a href="https://git-scm.com/downloads" target="_blank">Download</a>)</li>
|
||||
<li>Node.js (<a href="https://nodejs.org/en/download" target="_blank">Download</a></a>)</li>
|
||||
<li>MongoDB (<a href="https://www.mongodb.com/try/download/community" target="_blank">Download</a></a>)</li>
|
||||
</ul>
|
||||
<h2>Server Installation</h2>
|
||||
<ol>
|
||||
<li>Run <code>git clone https://openwf.io/SpaceNinjaServer.git</code> in a command prompt to download SpaceNinjaServer in the current working directory</li>
|
||||
<li>Open the SpaceNinjaServer folder</li>
|
||||
<li>Copy config-vanilla.json to create a config.json</li>
|
||||
<li>(Optional) Edit the config.json to match your MongoDB settings (if not default) and however else you would like to configure the server</li>
|
||||
<li>(Optional) If you have a GB of free space, you might want to download stripped assets such as <abbr title="Ability videos show a brief clip of an ability in action. They can be seen by hovering over an ability in the Arsenal, Codex, etc.">ability videos</abbr> so the client can request them on-demand: Run <code>git clone https://openwf.io/0.git</code> in the <code>static/data</code> folder</li>
|
||||
<li>Run <code>npm install --omit=dev --omit=optional</code> to install library dependencies</li>
|
||||
<li>Now you can run <code>npm run raw</code> to start the server anytime</li>
|
||||
</ol>
|
||||
<h2>Server Update</h2>
|
||||
<p>You can simply run the <code>UPDATE AND START SERVER</code> script for this, but otherwise the steps are pretty simple:</p>
|
||||
<ol>
|
||||
<li>Run <code>git pull</code> in the SpaceNinjaServer folder</li>
|
||||
<li>(Optional) If you have the stripped assets, run <code>git pull</code> in the <code>static/data/0</code> folder</li>
|
||||
<li>Run <code>npm install --omit=dev --omit=optional</code> to synchronize library dependencies</li>
|
||||
<li>Now you can use <code>npm run raw</code> to start the server again</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div id="docker-guide" class="d-none">
|
||||
<h2>Server Prerequisites</h2>
|
||||
<ul>
|
||||
<li>Git (<a href="https://git-scm.com/downloads" target="_blank">Download</a>)</li>
|
||||
<li>Docker (<a href="https://www.docker.com/" target="_blank">Download</a>)</li>
|
||||
</ul>
|
||||
<h2>Server Installation</h2>
|
||||
<ol>
|
||||
<li>Run <code>git clone https://onlyg.it/OpenWF/Docker-AIO "OpenWF Dockerized Server"</code> to set up an OpenWF Dockerized Server folder in the working directory</li>
|
||||
<li>Open the OpenWF Dockerized Server folder</li>
|
||||
<li>(Optional) If you have a GB of free space, you might want to download stripped assets such as <abbr title="Ability videos show a brief clip of an ability in action. They can be seen by hovering over an ability in the Arsenal, Codex, etc.">ability videos</abbr> so the client can request them on-demand: Run <code>git clone https://openwf.io/0.git</code> in the <code>static-data</code> folder</li>
|
||||
<li>Now you can run <code>docker compose up</code> to start the server anytime</li>
|
||||
</ol>
|
||||
<h2>Server Update</h2>
|
||||
<ol>
|
||||
<li>Run <code>docker compose pull</code> in the OpenWF Dockerized Server folder</li>
|
||||
<li>(Optional) If you have the stripped assets, run <code>git pull</code> in the <code>static-data/0</code> folder</li>
|
||||
<li>Now you can use <code>docker compose up</code> to start the server again</li>
|
||||
</ol>
|
||||
</div>
|
||||
<h2>Client Patch</h2>
|
||||
<p>In order to connect to custom servers, the client needs to be patched, which is what the boostrapper is for.</p>
|
||||
<ul>
|
||||
@ -41,14 +68,46 @@
|
||||
<li><b>Usage:</b> With the DLL in place, you can double-click Warframe.x64.exe to start the game with OpenWF.<!-- Opening the game's launcher will revert it back to normal. --></li>
|
||||
</ul>
|
||||
<p>The bootstrapper is <a href="bootstrapper-manual<?=(!empty($ext) ? ".html" : "");?>" target="_blank">fully documented here</a>, but the most important point is that, while the game is running, you can visit <a href="http://localhost:6155/" target="_blank">http://localhost:6155/</a> to manage options, cheats, and scripts.</p>
|
||||
<h2>IRC Server</h2>
|
||||
<p>In addition to SpaceNinjaServer, you can also set up an IRC server for the in-game chat:</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/Sainan/warframe-irc-server/releases" target="_blank">warframe-irc-server</a> — an IRC server specifically made for OpenWF. Talks to SpaceNinjaServer to give "chat moderator" permissions and report dropped connections.</li>
|
||||
<li>InspIRCd — a well-known IRC server implementation used by DE themselves (albeit with unknown modifications). A pre-configured Windows copy of it can be downloaded <a href="https://openwf.io/supplementals/IRC.zip" download>here</a>.</li>
|
||||
</ul>
|
||||
<div id="irc-server-guide">
|
||||
<h2>IRC Server</h2>
|
||||
<p>In addition to SpaceNinjaServer, you can also set up an IRC server for the in-game chat:</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/Sainan/warframe-irc-server/releases" target="_blank">warframe-irc-server</a> — an IRC server specifically made for OpenWF. Talks to SpaceNinjaServer to give "chat moderator" permissions and report dropped connections.</li>
|
||||
<li>InspIRCd — a well-known IRC server implementation used by DE themselves (albeit with unknown modifications). A pre-configured Windows copy of it can be downloaded <a href="https://openwf.io/supplementals/IRC.zip" download>here</a>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<script src="_assets/bootstrap.bundle.min.js"></script>
|
||||
<script src="_assets/censorcanary.min.js" defer></script>
|
||||
<script>
|
||||
window.onhashchange = function()
|
||||
{
|
||||
if (location.hash == "#docker")
|
||||
{
|
||||
document.getElementById("web-server-guide").classList.add("d-none");
|
||||
document.getElementById("irc-server-guide").classList.add("d-none");
|
||||
document.getElementById("docker-guide").classList.remove("d-none");
|
||||
}
|
||||
else
|
||||
{
|
||||
document.getElementById("web-server-guide").classList.remove("d-none");
|
||||
document.getElementById("irc-server-guide").classList.remove("d-none");
|
||||
document.getElementById("docker-guide").classList.add("d-none");
|
||||
}
|
||||
};
|
||||
window.onhashchange();
|
||||
|
||||
document.getElementById("docker-toggle").onchange = function()
|
||||
{
|
||||
if (this.checked)
|
||||
{
|
||||
location.hash = "#docker";
|
||||
}
|
||||
else
|
||||
{
|
||||
location.hash = "#";
|
||||
}
|
||||
};
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user