Skip to content

Commit

Permalink
Update server installation and maintenance to follow the new website …
Browse files Browse the repository at this point in the history
…download options (BeamMP#2)

Updated the pages as following:
- New instructions for installation/updates as per the new website's
download options;
- Updated dead link to the Linux dependencies;

Note: please fact check the Linux steps as I have not tested them!
  • Loading branch information
lionkor authored Dec 22, 2023
2 parents 00e5844 + bfe051f commit 64f0bf1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
20 changes: 11 additions & 9 deletions home/server-installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ <h2>3.a. Installation on Windows</h2>
<p>For the Linux installation, see the next step.</p>
<p>Please ensure you have port-forwarded before attempting to host a server! Without you ports being forwarded, you cannot host a server to the public!</p>
<ol>
<li>Download the server zip from <a href="https://www.beammp.com/">beammp.com</a>. You should end up with a compressed <code>.zip</code> archive, called something like <code>BeamMP-Server.zip</code>.</li>
<li>Extract the <code>BeamMP-Server.zip</code>. You will end up with a <code>BeamMP-Server.exe</code> file, among others which you can ignore for now. Make a folder somewhere and put the <code>BeamMP-Server.exe</code> there. This is where your server will live.</li>
<li>Ensure you have installed the <a href="https://aka.ms/vs/17/release/vc_redist.x64.exe">Visual C++ Redistributables</a> in order to run the server.</li>
<li>Download the server executable from <a href="https://www.beammp.com/">beammp.com</a>. You should end up with an executable file, called something like <code>BeamMP-Server.exe</code>.</li>
<li>Once downloaded, make a folder somewhere and put the <code>BeamMP-Server.exe</code> there. This is where your server will live.</li>
<li>Start the server once by double-clicking on it. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a <code>Server.log</code> file and a <code>ServerConfig.toml</code> file next to your <code>BeamMP-Server.exe</code>.</li>
<li>(optional) For quick access in the future you can easily create a desktop shortcut to <code>BeamMP-Server.exe</code> using<strong> [Right click]</strong> &gt; <strong>Send to</strong> &gt; <strong>Desktop (create shortcut).</strong></li>
</ol>
Expand All @@ -61,19 +62,20 @@ <h2>3.a. Installation on Windows</h2>
<h2>3.b. Installation on Linux</h2>
<p>Skip this if you did “Installation on Windows”.</p>
<h3>Using our build (recommended)</h3>
<p>This step will work on Debian, Ubuntu, and similar Debian-derivatives on x86_64. If you're on a different distribution or architecture, refer to the "Building from source” step below.</p>
<p>This step will work on all distributions we provide binaries for <a href="https://github.com/BeamMP/BeamMP-Server/releases/latest">here</a>. If you're on a different distribution or architecture, refer to the "Building from source” step below.</p>
<ol>
<li>Ensure you have the dependencies installed which are listed <a href="https://github.com/BeamMP/BeamMP-Server#prerequisites">here</a>.</li>
<li>Download the server zip from <a href="https://www.beammp.com/">beammp.com</a>. You should end up with a compressed <code>.zip</code> archive, called something like <code>BeamMP-Server.zip</code>.</li>
<li>Extract the <code>BeamMP-Server.zip</code>. You will end up with a <code>BeamMP-Server-linux</code> file, among others which you can ignore for now. Make a folder somewhere and put the <code>BeamMP-Server-linux</code> there. This is where your server will live.</li>
<li>Open a terminal, go to that folder you put the <code>BeamMP-Server-linux</code> in, and run <code>chmod +x BeamMP-Server-linux</code>. This ensures that you have permissions to run it.</li>
<li>Start the server once by running it with <code>./BeamMP-Server-linux</code>. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a <code>Server.log</code> file and a <code>ServerConfig.toml</code> file next to your <code>BeamMP-Server-linux</code>.</li>
<li>Ensure you have the dependencies installed which are listed <a href="https://github.com/BeamMP/BeamMP-Server#runtime-dependencies">here</a>.</li>
<li>Go to <a href="https://beammp.com/">BeamMP.com</a> and click the “Download Server” button, you will be redirected to the server's Github release page.</li>
<li>Download the correct version for your distro. For sake of semplicity it will be called <code>BeamMP-Server-xxx</code> from now on, where <code>xxx</code> denotes the version for the distro you're using.</li>
<li>Once downloaded, you should see one file called <code>BeamMP-Server-xxx</code>, among others which you can ignore for now. Make a folder somewhere and put the <code>BeamMP-Server-xxx</code> there. This is where your server will live.</li>
<li>Open a terminal, go to that folder you put the <code>BeamMP-Server-xxx</code> in, and run <code>chmod +x BeamMP-Server-xxx</code>. This ensures that you have permissions to run it.</li>
<li>Start the server once by running it with <code>./BeamMP-Server-xxx</code>. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a <code>Server.log</code> file and a <code>ServerConfig.toml</code> file next to your <code>BeamMP-Server-xxx</code>.</li>
<li>(optional) It is heavily recommended to set up a user called <code>beammpserver</code> (or similar), as we do NOT recommend running the server as root, sudo or with your personal user account. You should then take steps to make sure that you start the server as this user only.</li>
</ol>
<p>Now proceed to the next step.</p>
<p>&nbsp;</p>
<h3>Building from source</h3>
<p>BeamMP-Server for Linux can be officially built on both Debian, Ubuntu, other Debian-derivatives, and ArchLinux. Other distributions are likely to work, too, but aren't officially supported. If you want to build it yourself you can do it by downloading the source on our <a href="https://github.com/BeamMP/BeamMP-Server">GitHub</a>, a tutorial can be found <a href="https://github.com/BeamMP/BeamMP-Server#build-instructions">here</a>.</p>
<p>Other distributions in addition to the ones that already have a binary <a href="https://github.com/BeamMP/BeamMP-Server/releases/latest">here</a> are likely to work too, but aren't officially supported. If you want to build it yourself you can do it by downloading the source on our <a href="https://github.com/BeamMP/BeamMP-Server">GitHub</a>, a tutorial can be found <a href="https://github.com/BeamMP/BeamMP-Server#build-instructions">here</a>.</p>
<p>At the end, make sure to run your server once with <code>./BeamMP-Server</code> and then proceed to the next step.</p>
<p>&nbsp;</p>
<h2>4. Configuration</h2>
Expand Down
15 changes: 8 additions & 7 deletions home/server-maintenance.html
Original file line number Diff line number Diff line change
Expand Up @@ -219,20 +219,21 @@ <h3>Managing the server yourself</h3>
<p>If you built from source, you just rebuild. Make sure to run <code>git submodule update --init --recursive</code> before you rebuild.</p>
<h4>On Windows</h4>
<ol>
<li>Ensure you have installed the <a href="https://aka.ms/vs/17/release/vc_redist.x64.exe">Visual C++ Redistributables</a> in order to run the server.</li>
<li>Go to <a href="https://beammp.com/">BeamMP.com</a> and click the “Download Server” button.</li>
<li>Once downloaded, extract the zip file. You should see a few files, one of them the <code>BeamMP-Server.exe</code>. We will call this one the “new executable”.</li>
<li>Once downloaded, you should see one file called <code>BeamMP-Server.exe</code>. We will call this one the “new executable”.</li>
<li>Go to the folder where your current <code>BeamMP-Server.exe</code> executable is located (same folder where your <code>ServerConfig.toml</code> is, usually). We will call this one the “old executable”.</li>
<li>Replace the old executable with the new executable (for example by copying or moving the new executable into the folder).</li>
</ol>
<h4>On Linux</h4>
<ol>
<li>Go to <a href="https://beammp.com/">BeamMP.com</a> and click the “Download Server” button.</li>
<li>Once downloaded, extract the zip file. You should see a few files, one of them the <code>BeamMP-Server-linux</code>. We will call this one the “new executable”.</li>
<li>Go to the folder where your current <code>BeamMP-Server-linux</code> executable is located (same folder where your <code>ServerConfig.toml</code> is, usually). We will call this one the “old executable”.</li>
<li>Go to <a href="https://beammp.com/">BeamMP.com</a> and click the “Download Server” button, you will be redirected to the server's Github release page.</li>
<li>Download the correct version for your distro. For sake of semplicity it will be called <code>BeamMP-Server-xxx</code> from now on, where <code>xxx</code> denotes the version for the distro you're using.</li>
<li>Once downloaded, you should see one file called <code>BeamMP-Server-xxx</code> depending on the version you've downloaded. We will call this one the “new executable”.</li>
<li>Go to the folder where your current <code>BeamMP-Server-xxx</code> executable is located (same folder where your <code>ServerConfig.toml</code> is, usually). We will call this one the “old executable”.</li>
<li>Replace the old executable with the new executable (for example by copying or moving the new executable into the folder).</li>
<li>Open a terminal in that folder where you just replaced the executable, and run <code>sudo chmod +x BeamMP-Server-linux</code>. This will make sure the server can be run.</li>
<li>Open a terminal in that folder where you just replaced the executable, and run <code>sudo chmod +x BeamMP-Server-xxx</code>. This will make sure the server can be run.</li>
</ol>
<h2>Automated Updates</h2>
<p>The server does not support automatic updates or update notifications (yet).</p>
<p>You can, however, ask the GitHub API for the lastest release by checking the server's version against the tags. You can get that by GET'ing from <code>https://api.github.com/repos/BeamMP/BeamMP-Server/git/refs/tags</code>.</p>
<h1>&nbsp;</h1>
<p>You can, however, ask the GitHub API for the lastest release by checking the server's version against the tags. You can get that by GET'ing from <code>https://api.github.com/repos/BeamMP/BeamMP-Server/git/refs/tags</code>.</p>

0 comments on commit 64f0bf1

Please sign in to comment.