mirror of
https://github.com/BeamMP/Docs.git
synced 2025-08-17 00:45:53 +00:00
Fix update-a-server-md
This commit is contained in:
alex.ita
O1LER
parent
ac2b6408a1
commit
fa239c8f19
@ -4,7 +4,7 @@
|
||||
Basics of setting up the server application
|
||||
|
||||
---
|
||||
## **Overview**
|
||||
### **Overview**
|
||||
|
||||
**Creating a Home Server is free, hosting one with a VPS is easier and more secure**
|
||||
|
||||
@ -22,14 +22,16 @@ Note: _The server only supports IPv4\. If you don't know which one you have, loo
|
||||
|
||||
Setup consists of the following steps, you should follow all of them.
|
||||
|
||||
## 1. Port forwarding
|
||||
### 1. Port forwarding
|
||||
|
||||
_If you are on a VPS (Virtual Private Server) or Rootserver, you can skip this step. If you're unsure about what a VPS or Rootserver is, you most likely aren't on one._
|
||||
|
||||
This step is necessary if you want someone outside of your household to join ("outside of your local network").
|
||||
|
||||
### DISCLAIMER:
|
||||
#### DISCLAIMER:
|
||||
|
||||
By Port forwarding you understand the risks of opening up ports on your home network to the public and therefor void the right to hold BeamMP accountable for any (serious) damages that may happen to you or your household.
|
||||
|
||||
Therefore it is recommended to host a Server with one of our partnered Services!
|
||||
|
||||
Paid Services
|
||||
@ -46,13 +48,15 @@ Paid Services
|
||||
|
||||
**any other companies offering BeamMP-Server hosting which aren't listed here are not legit and WILL charge you more than our partners**
|
||||
|
||||
*NOTE: if you host your server using one of our partners, the Port Forwarding step is not needed.*
|
||||
|
||||
Now back to Port Forwarding. This step is the same for almost every game's server, such as Minecraft Servers, so you can find many tutorials online for this, even for your specific router model. A good full guide is [this tutorial](https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/). Make sure you forward port **30814**, as **TCP** and **UDP**.
|
||||
|
||||
While the default **Port** you want to “forward” is **30814**, you can choose any other number >1024, but you need to note down what you picked if it's not 30814\. You need to forward both **TCP** and **UDP**.
|
||||
It is recommended to stick to the default port as that one is very unlikely to be used by another Service on your PC.
|
||||
NOTE: If you are hosting multiple Servers on one machine, each Server needs a different Port. Server 1: 30814, Server 2: 30815 for example.
|
||||
|
||||
## 1.1 Firewall
|
||||
#### 1.1 Firewall
|
||||
|
||||
Depending on your setup, you may need to let BeamMP-Server through your firewall. This is the case on Windows (turning the firewall off does **not** work usually), and on a lot of preinstalled Linux servers.
|
||||
|
||||
@ -60,13 +64,13 @@ There, just like with the port forwarding, you want to allow the BeamMP-Server t
|
||||
|
||||
If you have issues, also feel free to ask on our [Forum](https://forum.beammp.com) or on our [Discord server](https://discord.gg/beammp) in the `#support` channel.
|
||||
|
||||
## 2. Obtaining an Authentication Key
|
||||
### 2. Obtaining an Authentication Key
|
||||
|
||||
The “Authentication Key”, often called “AuthKey”, is necessary for making a **public** server, but **should** be done for private servers, too.
|
||||
|
||||
You will need a [Discord](https://discord.com) account for this step. This is necessary to prevent spam.
|
||||
|
||||
### 2.1. Accessing the keys page
|
||||
#### 2.1. Accessing the keys page
|
||||
|
||||
Login with Discord to the [Keymaster](https://beammp.com/keymaster).
|
||||
From the Keymaster homepage click on "Keys" on the left of the screen:
|
||||
@ -75,7 +79,7 @@ From the Keymaster homepage click on "Keys" on the left of the screen:
|
||||
|
||||
</figure>
|
||||
|
||||
### 2.2. Creating a key
|
||||
#### 2.2. Creating a key
|
||||
|
||||
To create your key click on the green "+" button in the top right.
|
||||
|
||||
@ -83,7 +87,7 @@ To create your key click on the green "+" button in the top right.
|
||||
|
||||
</figure>
|
||||
|
||||
### 2.3. Filling out the key information
|
||||
#### 2.3. Filling out the key information
|
||||
|
||||
Next, fill out the Server Name field (this is just the key name not the actual name of the server on the list), then click "Create". Example:
|
||||
|
||||
@ -101,7 +105,7 @@ It should, in the end, look something like this:
|
||||
|
||||
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.
|
||||
|
||||
### 2.4. Copying the key
|
||||
#### 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:
|
||||
|
||||
@ -109,11 +113,11 @@ Now copy the text in the “Key” field, in this example that is `3173a2e-6az0-
|
||||
|
||||
</figure>
|
||||
|
||||
## 3. Installation
|
||||
### 3. Installation
|
||||
|
||||
The BeamMP-Server is available for Windows and Linux. The next two sections are dedicated to Windows and Linux each.
|
||||
|
||||
### 3.a. Installation on Windows
|
||||
#### 3.a. Installation on Windows
|
||||
|
||||
For the Linux installation, see the next step.
|
||||
|
||||
@ -127,7 +131,7 @@ Please ensure you have port-forwarded before attempting to host a server at home
|
||||
|
||||
Now proceed to step "4\. Configuration".
|
||||
|
||||
### 3.b. Installation on Linux
|
||||
#### 3.b. Installation on Linux
|
||||
|
||||
##### Using our build (recommended)
|
||||
|
||||
@ -149,7 +153,7 @@ Other distributions in addition to the ones that already have a binary [here](ht
|
||||
|
||||
At the end, make sure to run your server once with `./BeamMP-Server` and then proceed to the next step.
|
||||
|
||||
## 4. Configuration
|
||||
### 4. Configuration
|
||||
|
||||
Now that you ran the server once, it should have created some files and probably uttered an error or two. This is because we are not yet done. Your folder should have these files:
|
||||
|
||||
@ -162,6 +166,7 @@ They might be called “ServerConfig”, “Server” and “BeamMP-Server” (n
|
||||
Open the `ServerConfig.toml` with a text editor such as `Notepad`. You can do this with [Right Click] → “Open With…” and then selecting a text editor.
|
||||
|
||||
You should see something like this:
|
||||
|
||||
```TOML
|
||||
[General]
|
||||
AuthKey = ''
|
||||
@ -175,6 +180,7 @@ Port = 30814
|
||||
Private = false
|
||||
ResourceFolder = 'Resources'
|
||||
```
|
||||
|
||||
This is your configuration file. It uses a format called TOML. Refer to the [Server Maintenance](server-maintenance.md) section for more info on this file.
|
||||
|
||||
For now, we only care about the `AuthKey` field. Between the quotes `''`, you want to paste in your AuthKey you copied in the first step.
|
||||
@ -189,61 +195,65 @@ If you picked a different **Port** other than **30814**, make sure to replace it
|
||||
|
||||
**IMPORTANT:** Your server will **NOT** show in the server list as long as `Private = True`. _If_ you want it to show in the list, set that to `**Private = False**`.
|
||||
|
||||
## 5. Validation
|
||||
### 5. Validation
|
||||
|
||||
Now run your server again, and see if it spits out any more `[ERROR]` messages. It should just stay open. At this point, you can start BeamMP through the BeamMP-Launcher and you should find your server by the Name you entered in the `ServerConfig.toml` in the server list.
|
||||
|
||||
|
||||
---
|
||||
|
||||
### 5.1 How to add mods to your server
|
||||
#### 5.1 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.
|
||||
|
||||
### 5.2 General Mods
|
||||
#### 5.2 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.3 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:
|
||||
|
||||
1. Put 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 `ServerConfig.toml`. In the `Map` setting, 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.
|
||||
|
||||
```TOML
|
||||
Map = '/levels/myawesomedriftmap2021/info.json'
|
||||
```
|
||||
|
||||
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!
|
||||
|
||||
## 6 How to join your server
|
||||
### 6. How to join your server
|
||||
|
||||
How you and other people can join your server.
|
||||
|
||||
### 6.1a Joining your own server
|
||||
#### 6.a. Joining your own server
|
||||
|
||||
You must join your server by direct connecting, to do this, click the **Direct Connect Tab** on the left from the server list. Leave the default info in there (should be 127.0.0.1 and a port of 30814) then hit connect.If you server is hosted outside of your house you must [find your IP](https://whatismyipaddress.com/) on that machine and direct connect that way.
|
||||
|
||||
### 6.1b Other people joining your server
|
||||
#### 6.b. Other people joining your private server
|
||||
|
||||
### For private servers:
|
||||
Start the Server. You have to give the people the IP Address of your Server. However, be careful sharing your homes public IP Address!
|
||||
Start the Server. You have to give the people the IP Address of your Server. However, be careful sharing your homes public IP Address! To join your private server the players must go to the **Direct Connect Tab** in BeamMP, then type your IP and Port.
|
||||
|
||||
### For public Servers:
|
||||
Start the Server, wait a few minutes and the Server should be in the **Public Servers** List upon searching it by its name entered into the `ServerConfig.toml`
|
||||
#### 6.c. Other people joining your public server
|
||||
|
||||
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.
|
||||
You can also check the [Keymaster](https://beammp.com/keymaster) Website for the Servers IP Address.
|
||||
|
||||
Should you or your friends experience a "Connection Failed!" Error, check the Launcher Window for codes like 10060, 10061, 10030.
|
||||
This means you eihter have a CGNAT IPv4, or you have done something wrong during Step **1 Port Forwarding** or **1.1. Firewall**.
|
||||
To check if you have a CGNAT IPv4, look up the WAN IP Address on your routers interface. Compare it to your public IP listed on [_whatsmyip.org_](https://www.whatsmyip.org/)
|
||||
To check if you have a CGNAT IPv4, look up the WAN IP Address on your routers interface. Compare it to your public IP listed on [_whatsmyip.org_](https://www.whatsmyip.org/).
|
||||
IPv6 Support is **NOT** yet implemented.
|
||||
|
||||
#### 6.d. **[MAY NOT WORK]** For private servers (Hamachi):
|
||||
|
||||
For someone to join your server, they must be on your Hamachi network, you do not need to be port forwarded for this. After joining your Hamachi network they will use the Hamachi IP and default port to direct connect to your server. For more info see our [Hamachi](https://forum.beammp.com/t/tutorial-how-to-host-a-server-with-logmein-hamachi/52) guide.
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
@ -30,7 +30,29 @@ La configurazione consiste di pochi passi che sono obbligatori da seguire.
|
||||
|
||||
Questo passo è necessario se vuoi che qualcuno all'esterno della tua casa ("all'esterno del tuo network locale o LAN") possa accedere al server.
|
||||
|
||||
Questo passo è praticamente il medesimo per tutti i server di gioco, come i server di Minecraft, quindi puoi trovare molte guide su internet riguardo all'argomento, anche per il tuo router in specifico. Una buona guida è [la seguente](https://www.aranzulla.it/come-aprire-le-porte-del-router-31808.html). Assicurati di aggiungere nelle regole di forwarding la porta **30814** sia in protocollo **TCP** sia in **UDP**.
|
||||
#### LIMITAZIONE DI RESPONSABILITA'
|
||||
|
||||
Facendo il port forwarding sei a conoscenza dei rischi legati ad aprire le porte del tuo network di casa al pubblico e di conseguenza sollevi BeamMP da ogni responsabilità di danni che potrebbero succedere a te o al tuo ambiente domestico.
|
||||
|
||||
Sapendo ciò, è raccomandato per gli utenti meno esperti di utilizzare uno dei seguenti partner di hosting:
|
||||
|
||||
Servizi a pagamento:
|
||||
* [Horizon Hosting](https://hrzn.link/beammp)
|
||||
* [Racing Game Servers](https://racinggameservers.com/games/beamng-drive/)
|
||||
* [Snakecraft Hosting](https://schost.us/beammp-plans)
|
||||
* [Connect Hosting](https://connecthosting.net/beammp)
|
||||
* [Assetto Hosting](https://assettohosting.com/en/games/beamng)
|
||||
* [WinHeberg](https://winheberg.fr/offres/gaming/beammp?lang=en)
|
||||
* [Street Inc](https://billing.streetinc.org/)
|
||||
* [Zap Hosting](https://zap-hosting.com/en/beammp-server-hosting/)
|
||||
* [HostHavoc](https://hosthavoc.com/)
|
||||
* [PedalHost](https://pedal.host/)
|
||||
|
||||
**Altre compagnie che offrono hosting di BeamMP-Server non sono affiliate e sono più costose dei nostri partner.**
|
||||
|
||||
*NOTA: se se sceglie di acquistare il server da uno dei partner, il passo di Port Forwarding è superfluo.*
|
||||
|
||||
Tornando al port forwarding, questo passo è praticamente il medesimo per tutti i server di gioco, come i server di Minecraft, quindi puoi trovare molte guide su internet riguardo all'argomento, anche per il tuo router in specifico. Una buona guida è [la seguente](https://www.aranzulla.it/come-aprire-le-porte-del-router-31808.html). Assicurati di aggiungere nelle regole di forwarding la porta **30814** sia in protocollo **TCP** sia in **UDP**.
|
||||
|
||||
La **porta** di default può essere cambiata con quella che desideri, basta che non sia già utilizzata da altri servizi e che il numero sia >1024. Ricordati o segnati quale porta hai scelto se non usi quella predefinita. Il forwarding deve essere sempre fatto sia in protocollo **TCP** sia in **UDP**.
|
||||
|
||||
@ -188,15 +210,15 @@ Avvia nuovamente il server e guarda se mostra altri messaggi con l'etichetta `[E
|
||||
|
||||
---
|
||||
|
||||
## Come aggiungere mod al tuo server
|
||||
#### 5.1. Come aggiungere mod al tuo server
|
||||
|
||||
Sia le mod dei veicoli che una mappa mod, vanno inserite nella cartella `Resources/Client` all'interno della cartella del server.
|
||||
|
||||
### Mod generiche
|
||||
#### 5.2. Mod generiche
|
||||
|
||||
Se ti interessa aggiungere mod di veicoli, basta aggiungerle alla cartella `Resources/Client`. Verranno scaricate automaticamente da chiunque si connetta al server.
|
||||
|
||||
### Mappe
|
||||
#### 5.3. Mappe
|
||||
|
||||
Tutte le mappe ufficiali del gioco (quindi che non sono mod) non necessitano di essere installate, devi soltanto cambiare il valore del campo `Map` del file `ServerConfig.toml` con una di [queste stringhe](server-maintenance.md#tutti-i-nomi-delle-mappe-vanilla). Per mappe non ufficiali (mod), bisogna fare così:
|
||||
|
||||
@ -214,22 +236,33 @@ La mappa, come tutte le altre mod, verrà scaricata automaticamente da chiunque
|
||||
|
||||
Il tuo server con la mappa moddata è pronto!
|
||||
|
||||
## Come connettersi a un server
|
||||
### 6. Come connettersi a un server
|
||||
|
||||
Come tu e altre persone possono connettersi al tuo server.
|
||||
|
||||
### Connettersi al proprio server
|
||||
#### 6.a. Connettersi al proprio server
|
||||
|
||||
Se sei il proprietario del server devi connetterti tramite connessione diretta, per fare questo, clicca il pulsante **Direct Connect** a sinistra della lista dei server. Lascia i parametri predefiniti (IP `127.0.0.1` e porta `30814`) e clicca `Connect`. Se il tuo server è in esecuzione all'esterno della tua LAN devi prima [trovare il suo IP](https://whatismyipaddress.com/) e poi connetterti direttamente.
|
||||
|
||||
### Connessione di altre persone al proprio server (Pubblico)
|
||||
#### 6.b. Connessione di altre persone al proprio server privato
|
||||
|
||||
Chiunque può connettersi al tuo server fintanto che si sia fatto port forwarding (una buona guida è [la seguente](https://www.aranzulla.it/come-aprire-le-porte-del-router-31808.html)). Per connettersi a un server pubblico basta andare sulla lista dei server, cercare il nome del server e cliccare `Connect`. Se non sei sicuro del nome del server, è lo stesso che hai messo nel file `ServerConfig.toml`.
|
||||
Avviare il server. Devi condividere l'indirizzo IP e la porta del tuo server alle persone che vuoi che si connettano. Presta attenzione a chi condividi il tuo indirizzo IP! Per connettersi a un server privato clicca il pulsante **Direct Connect** a sinistra della lista dei server, dopodiché inserisci l'indirizzo IP e la porta del server.
|
||||
|
||||
### Connessione di altre persone al proprio server (Privato)
|
||||
#### 6.c. Connessione di altre persone al proprio server pubblico
|
||||
|
||||
Chiunque può connettersi al tuo server fintanto che si sia fatto port forwarding (una buona guida è [la seguente](https://www.aranzulla.it/come-aprire-le-porte-del-router-31808.html)). Per connettersi a un server privato clicca il pulsante **Direct Connect** a sinistra della lista dei server, dopodiché inserisci l'indirizzo IP e la porta del server. Se non sei sicuro di quale sia il tuo IP, puoi verificarlo da [questo sito](https://whatismyipaddress.com/). Se non sei sicuro della porta, è la stessa che hai messo nel file `ServerConfig.toml`.
|
||||
Per connettersi a un server pubblico basta andare sulla lista dei server, cercare il nome del server e cliccare `Connect`. Se non sei sicuro del nome del server, è lo stesso che hai messo nel file `ServerConfig.toml`.
|
||||
Assicurarsi che i filtri di ricerca siano disabilitati e che la ricerca per mappa sia impostata su "Any".
|
||||
Puoi controllare il [Keymaster](https://beammp.com/keymaster) per recuperare l'indirizzo IP.
|
||||
|
||||
### Connessione di altre persone al proprio server (Hamachi)
|
||||
Nel caso in cui si vede l'errore "Connection Failed!", controllare il launcher per dei codici come 10060, 10061, 10030.
|
||||
In questo caso siete sotto CGNAT o qualcosa è andato storto nel passo `1. Port forwarding` o `1.1 Firewall`.
|
||||
Per controllare se si è sotto CGNAT, confrontare l'indirizzo IP WAN dalla pagina del router con l'indirizzo IP visibile da [_whatsmyip.org_](https://www.whatsmyip.org/).
|
||||
IPv6 **non** è ancora supportato.
|
||||
|
||||
#### 6.e. **[POTREBBE NON FUNZIONARE]** Connessione di altre persone al proprio server (Hamachi)
|
||||
|
||||
Solo le persone nel tuo network di Hamachi possono connettersi al tuo server, non è necessario fare port forwarding in questo caso. Chi vuole connettersi, dopo essere entrato nel tuo network Hamachi, userà l'IP di Hamachi e la porta predefinita per eseguire una connessione diretta al tuo server. Per maggiori informazioni guarda la nostra guida per gli utenti [Hamachi](https://forum.beammp.com/t/tutorial-how-to-host-a-server-with-logmein-hamachi/52).
|
||||
|
||||
## Hai ancora dei problemi?
|
||||
|
||||
Apri un thread sul [Forum](https://forum.beammp.com) o sul nostro [server Discord](https://discord.gg/beammp) nel canale `#support`.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user