diff --git a/docs/en/server/create-a-server.md b/docs/en/server/create-a-server.md index 143f988f..82229253 100644 --- a/docs/en/server/create-a-server.md +++ b/docs/en/server/create-a-server.md @@ -2,6 +2,8 @@ ## **Creating a Server** Basics of setting up the server application +This guide covers the full setup to host a server **at home**. +For a quick-start guide for your VPS hosted server, visit [How to create a aserver](https://docs.beammp.com/server/setup-vps/) --- ### **Overview** @@ -207,26 +209,27 @@ Give your server a name, too, in the `Name` field. You can format this with colo If you picked a different **Port** other than **30814**, make sure to replace it here under `Port`. -### **5. Validation** +#### **4.1. Validation** Now run your server again, and see if it spits out any more `[ERROR]` or `[WARN]` messages. The server should stay open now. In the following steps (6.) below you can find out how to join the server. --- -#### 5.1 How to add mods to your server +### 5. How to add mods to your server Vehicle mods and map mods are different to install, but both require you to put them in your server's (`Resources/Client`) folder. Simply slide any mod you want to add in that folder. !!! warning + Mods can be, and/or become incompatible with BeamNG, BeamMP or even other mods. Start removing mods if you are encountering issues. Should you receive a "done" or "start" message when trying to join your server after adding mods, you likely added an incompatible or broken mod to your server. Mod incompatibilities can also occur between 2 or more mods. If you have client mods installed, check [this guide](../../FAQ/How-to-deactivate-mods.md) about removing mods from your game. -#### 5.2 General Mods +#### 5.1 General Mods If you only wanted to add modded vehicles, you simply put the zip file of the mod in the `Resources/Client` folder. They will automatically be downloaded by anyone who joins your server. -#### 5.3 Maps +#### 5.2 Maps All default maps (maps which aren't mods) work out-of-the-box and do not have to be installed. You simply change the `Map` setting in the `ServerConfig.toml` file to any of [these](server-maintenance.md#all-vanilla-maps-names). For any other modded maps, do this: @@ -254,7 +257,7 @@ If your server is hosted on the same PC as the game runs on, you must join your If your server is hosted on another PC in your local network, you must find the local IP of that machine and direct connect using this local IP. -If your server is hosted outside of your house (e.g. VPS) you must find the [public IP](https://whatismyipaddress.com/) of that machine and direct connect that way. +If your server is hosted outside of your house (e.g. VPS) you must find the public IP of that machine and direct connect that way. #### 6.b. Other people joining your private server @@ -293,4 +296,4 @@ Enter the servers public IPv4 and Port below, then click "CheckBeamMP". ## Still facing issues? -Open a Thread on the [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#support` channel. +Open a Thread on the [Forum](https://forum.beammp.com) or file a **Server Support Ticket** on our [Discord server](https://discord.gg/beammp) in the `#support` channel. diff --git a/docs/en/server/setup-vps.md b/docs/en/server/setup-vps.md new file mode 100644 index 00000000..0ece7059 --- /dev/null +++ b/docs/en/server/setup-vps.md @@ -0,0 +1,160 @@ +# Server Setup on VPS + +## **Setting up a server** +Basics of setting up the server application +This guide assumes you are hosting a server **on a VPS with a Management panel** +For an in-depth guide regarding hosting a server at home, visit [How to create a aserver](https://docs.beammp.com/server/create-a-server/). + +### **Overview** + +**Creating a Home Server is free, hosting one with a VPS is easier and more secure** + +Servers are an integral part of BeamMP; players are connected to each other through the server. They run natively on Windows and Linux. + +You can make private servers, which only people you invite can join, or public servers, which will show in our official server list. + +Getting a server up and running is a process of a few steps! If you run into any issues, feel free to ask on our [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#support` channel. Also refer to the [Server Maintenance](server-maintenance.md) section for more info. + +Please make sure to read the [LICENSE](https://raw.githubusercontent.com/BeamMP/BeamMP-Server/master/LICENSE) of the server before use. + +!!! Info + + Hosting a server using a VPS, does not require any firewall or port forwarding changes to your router. + +If you haven't chosen a VPS to host your server on yet, check out our **Partnered Hosting Services (paid)**: + +??? Abstract "Partnered hosting services" + + * [Horizon Hosting](https://hrzn.link/beammp) + * [RackGenius](https://rackgeni.us/beammp-plans) + * [Connect Hosting](https://connecthosting.net/beammp) + * [Assetto Hosting](https://assettohosting.com/en/games/beamng) + * [ZAP-Hosting](https://zap-hosting.com/itsbeammp) + * [HostHavoc](https://hosthavoc.com/) + * [PedalHost](https://pedal.host/) + * [Vyper Hosting](https://vyperhosting.com/r/beammp) + * [BisectHosting](https://www.bisecthosting.com/beammp-server-hosting) + * [Four Seasons Hosting](https://fourseasonshosting.com) + * [Vertuo Hosting](https://vertuohosting.com) + * [Winheberg](https://winheberg.fr/offres/gaming/beammp?lang=en) + * [Wabbanode](https://wabbanode.com/partner/beammp) + * [Iceline Hosting](https://iceline-hosting.com/games/beammp) + (We take no responsibility for any content on any externally linked services or websites.) + +### **1. Setting up the VPS** + +First, you need to make sure that your Server management page is reachable. +Once you verified that the Server is ready for operation, proceed to step 2. + +### **2. Obtaining an Authentication Key** + +The “Authentication Key”, often called “AuthKey”, is necessary for making a **public** server accessible by the serverlist. Though it is recommended to add the authkey to private servers as well. +You have a limited number of keys. One key can be used on one server at a time, so you cannot start two servers at the same time with the same key. +More keys can be obtained by supporting the project. Read [this article](https://docs.beammp.com/support/player-faq/) for more information. + +!!! warning + + DO NOT EVER SHARE THIS KEY OR SHOW IT TO ANYONE. TREAT THIS LIKE A PASSWORD. + +You will need a [Discord](https://discord.com) account for this step. This is necessary to prevent spam. + +#### 2.1. Accessing the keys page + +Login with Discord to the [Keymaster](https://keymaster.beammp.com). +From the Keymaster homepage click on "Keys" on the left of the screen: + +
+ ![](../../assets/content/keymaster_homepage.png) +
+ +#### 2.2. Creating a key + +To create your key, click on the green "+" button in the top right.  + +
+ ![](../../assets/content/keymaster_new_key.png) +
+ +#### 2.3. Filling out the key information + +Next, fill out the Server Name field (this is just the keys name and not the actual name of the server on the list), then click "Create". Example: + +
+ ![](../../assets/content/keymaster_server_name.png) +
+ +It should, in the end, look something like this: + +
+ ![](../../assets/content/keymaster_key_done.png) +
+ +#### 2.4. Copying the key + +Now copy the text in the “Key” field, in this example that is `3173a2e-6az0-4542-a3p0-ddqq5ff95558` and hold onto it for the next step. You can do this by clicking the clipboard on the right of the key: + +
+ ![](../../assets/content/keymaster_copy_key.png) +
+ +!!! warning + + You will not be able to edit the ServerConfig.toml file directly in the File Manager. This is intentional to enforce e.g. player limits by the hosting company. + +### **3. Populating the fields** + +The hosting panel will feature a few fields to enter something into. Some fields may be marked with "*", which means they are mandatory to fill out. +With the authkey in your clipboard, find the "Authkey" field on the management panel to paste the key into. +Give your Server a Name and description as well! For customization of such in the form of colors and more, refer to [this section on Name customization](server-maintenance.md#customize-the-look-of-your-server-name) on the maintenance page. + +#### **3.1. Validation** + +Now run your server, and see if it spits out any more `[ERROR]` or `[WARN]` messages. The server should stay up now. In the following steps below you can find out how to join the server and add mods. + +### **4. Adding mods to your server** + +You may add mods to your server using the provided file manager. +Vehicle mods and map mods are different to install, but both require you to put them in your server's (`Resources/Client`) folder. Simply slide any mod you want to add in that folder. + +!!! warning + + Mods can be, and/or become incompatible with BeamNG, BeamMP or even other mods. Start removing mods if you are encountering issues. + Should you receive a "done" or "start" message when trying to join your server after adding mods, you likely added an incompatible or broken mod to your server. + Mod incompatibilities can also occur between 2 or more mods. If you have client mods installed, check [this guide](../../FAQ/How-to-deactivate-mods.md) about removing mods from your game. + +#### 4.1 General Mods + +If you only wanted to add modded vehicles, you simply put the zip file of the mod in the `Resources/Client` folder. They will automatically be downloaded by anyone who joins your server. + +#### 4.2 Maps + +All default maps (maps which aren't mods) work out-of-the-box and do not have to be installed. You simply change the `Map` path in the Map field of the management panel to any of [these](server-maintenance.md#all-vanilla-maps-names). For any other modded maps, do this: + +1. Place your map's `.zip` file in your server's (`Resources/Client`) folder. +2. Next, have a look inside the map's zip file (don't extract it) and open the `levels` folder. In this folder there should be simply one other folder with the name of the map, for example “myawesomedriftmap2021”. Make sure to copy or remember this name _exactly as it is written in that folder's name._ +3. Open your management panel. In the `Map` field, you should see `/levels/MAPNAME/info.json`, where `MAPNAME` is likely something like `gridmap_v2`. You want to now replace this `MAPNAME` with the name of the folder from the last step, in that example it was `myawesomedriftmap2021`. In the end it should look like this (for this example) and _**should**_ have `/info.json` at the end. + +Now, when someone joins your server, it should download the map automatically and work as expected.  + +**If this does NOT work**, install the map in your singleplayer BeamNG.drive, launch it and enter the map. Then, open the Console by pressing the `~` (_tilde_) key (if you're on a non-US keyboard, look at the **Toggle System Console** action in the **Options > Controls > Bindings** menu, under the **General Debug** section), and run `print(getMissionFilename())`. This should then show you the name to use.  + +That's it! Your modded map should now be available to join! + +### **5. How to join your server** + +How you and other players can join your server. + +#### 6. Joining your own server (both private and public) + +You can direct connect to the pubblic IP and Port of the server, found on the management panel. The same IP and Port have to be entered by any other users trying to connect to this server. +You can also check the [Keymaster](https://keymaster.beammp.com/) Website for the Servers IP Address. +To join your public server they can simply go to the server list, type the name of the server, and click connect. If you are unsure of what your server name is, it will be the name you put in the `ServerConfig.toml`. +Make sure search filters are disabled and the Map set to "Any" if you can't find it. + +Should you or your friends experience a "Connection Failed!" Error, check the Launcher Window for codes like 10060, 10061, 10030. +This means the server is unreachable, or you entered incorrect parameters into the IP and Port field on your client. +IPv6 Support is **NOT** yet implemented. + +## Still facing issues? + +Open a Thread on the [Forum](https://forum.beammp.com) or file a **Server Support Ticket** on our [Discord server](https://discord.gg/beammp) in the `#support` channel. diff --git a/mkdocs.yml b/mkdocs.yml index 3aa78067..626f67b9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -116,7 +116,8 @@ plugins: Error Codes: Códigos de error Multiplayer Settings: Ajustes multijugador Running a Server: Ejecutando un Servidor - Server Installation: Instalación del Servidor + Server Setup (Home): Configuración del servidor (Inicio) + Server Setup (VPS): Configuración del servidor (VPS) Server Maintenance: Manutención del Servidor Error Codes: Códigos de error Server Manual: Manual del Servidor @@ -161,7 +162,8 @@ plugins: Error Codes: Fehlercodes Multiplayer Settings: Einstellungen anpassen Running a Server: Server ausführen - Server Installation: Server Installation + Server Setup (ome): Server Einrichtung (Zuhause) + Server Setup (VPS): Server Einrichtung (VPS) Server Maintenance: Server Wartung Error Codes: Fehlercodes Server Manual: Server Handbuch @@ -206,7 +208,8 @@ plugins: Error Codes: Codes d'erreur Multiplayer Settings: Paramètres multijoueurs Running a Server: Exécution d'un serveur - Server Installation: Installation du serveur + Server Setup (Home): Configuration du serveur (Accueil) + Server Setup (VPS): Configuration du serveur (VPS) Server Maintenance: Maintenance du serveur Error Codes: Codes d'erreur Server Manual: Manuel du serveur @@ -251,7 +254,8 @@ plugins: Error Codes: Codici di errore Multiplayer Settings: Impostazioni multigiocatore Running a Server: Eseguire un server - Server Installation: Installazione del server + Server Setup (Home): Configurazione del server (Home) + Server Setup (VPS): Configurazione del server (VPS) Server Maintenance: Manutenzione del server Error Codes: Codici di errore Server Manual: Manuale del server @@ -296,7 +300,8 @@ plugins: Error Codes: коды ошибок Multiplayer Settings: Настройки мультиплеера Running a Server: Запуск сервера - Server Installation: Установка сервера + Server Setup (Home): Настройка сервера (Главная) + Server Setup (VPS): Настройка сервера (VPS) Server Maintenance: Обслуживание сервера Error Codes: коды ошибок Server Manual: Руководство по серверу @@ -341,7 +346,8 @@ plugins: Error Codes: 错误代码 Multiplayer Settings: 多人模式设置 Running a Server: 运行服务器 - Server Installation: 服务器端的安装 + Server Setup (Home): 服务器设置(首页) + Server Setup (VPS): 服务器设置(VPS) Server Maintenance: 服务器维护 Error Codes: 错误代码 Server Manual: 服务器手册 @@ -412,7 +418,8 @@ nav: - Error Codes: game/error-codes.md - Multiplayer Settings: game/multiplayer-settings.md - Running a BeamMP-Server: - - Server Installation: server/create-a-server.md + - Server Setup (Home): server/create-a-server.md + - Server Setup (VPS): server/setup-vps.md - Port Forwarding: server/port-forwarding.md - Server Maintenance: server/server-maintenance.md - Error Codes: server/error-codes.md