Updated installation/maintenance as per review request.

- Added the C++ redistributables to the windows installation/maintenance;
- Made the Linux steps less distro specific;
This commit is contained in:
alex.ita 2023-12-11 11:29:27 +01:00
parent d326f4712e
commit b93b747e86
2 changed files with 10 additions and 8 deletions

View File

@ -51,6 +51,7 @@ dateCreated: 2020-06-17T21:05:01.162Z
<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>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>
@ -65,10 +66,10 @@ dateCreated: 2020-06-17T21:05:01.162Z
<ol>
<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 (Debian/Ubuntu).</li>
<li>Once downloaded, you should see one file called <code>BeamMP-Server-debian</code> or <code>BeamMP-Server-ubuntu</code> depending on the version you've downloaded, among others which you can ignore for now. Make a folder somewhere and put the <code>BeamMP-Server-debian</code> (or <code>BeamMP-Server-ubuntu</code>) there. This is where your server will live.</li>
<li>Open a terminal, go to that folder you put the <code>BeamMP-Server-debian</code> (or <code>BeamMP-Server-ubuntu</code>) in, and run <code>chmod +x BeamMP-Server-debian</code> (or <code>sudo chmod +x BeamMP-Server-ubuntu</code>). This ensures that you have permissions to run it.</li>
<li>Start the server once by running it with <code>./BeamMP-Server-debian</code> (or <code>./BeamMP-Server-ubuntu</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-debian</code> (or <code>BeamMP-Server-ubuntu</code>).</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>

View File

@ -219,6 +219,7 @@ dateCreated: 2021-06-20T08:48:03.720Z
<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, 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>
@ -227,11 +228,11 @@ dateCreated: 2021-06-20T08:48:03.720Z
<h4>On Linux</h4>
<ol>
<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 (Debian/Ubuntu).</li>
<li>Once downloaded, you should see one file called <code>BeamMP-Server-debian</code> or <code>BeamMP-Server-ubuntu</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-debian</code> (or <code>BeamMP-Server-ubuntu</code>) executable is located (same folder where your <code>ServerConfig.toml</code> is, usually). We will call this one the “old executable”.</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-debian</code> (or <code>sudo chmod +x BeamMP-Server-ubuntu</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>