BeamOnline
Guide · for hosts

Host a
server

A BeamOnline server is one small program. It doesn't need BeamNG.drive or a graphics card: it passes what each player's game sends to the others. A cheap Linux VPS runs it all day; a Windows PC works too.

Players connect on
UDP port 47800 (you can choose another).
Resources
One CPU core and 256 MB of memory are plenty for a few dozen players.
Upload
Roughly 3.6 Mbit/s for 8 players driving one car each at the default 50 updates a second (2.2 at 30).
1

Get a VPS

Any 64-bit Linux server with systemd works; Ubuntu or Debian are the easiest. The cheapest plan is enough. Pick a location close to your players: the public list shows it as a flag. Note the VPS's IP address and its root (or sudo) login.

2

Get the installer

It's one file, beamonline-server-install.sh. It carries everything it needs and checks itself before it runs.

Download the installer Coming with the first public test. Testers make it from the source folder on Windows:
PowerShell · in the BeamOnline source folder
powershell -ExecutionPolicy Bypass -File tools\make-linux-installer.ps1

It's written to build\dist\.

3

Upload it

From the folder the file is in on your PC. Put your VPS's address instead of YOUR_VPS_IP. (Prefer clicking? WinSCP or your provider's file upload do the same.)

PowerShell · on your PC
scp beamonline-server-install.sh root@YOUR_VPS_IP:~
4

Connect to the VPS

PowerShell · on your PC
ssh root@YOUR_VPS_IP

Everything from here on is typed on the VPS.

5

Run the installer

Bash · on the VPS
sudo bash beamonline-server-install.sh

It shows its steps as it goes ([1/7] Getting ready …). It installs what it needs, builds the server (a few minutes; small VPSes get temporary extra memory), creates its own user, and asks the setup questions below.

6

Answer the setup questions

Press Enter to keep the value in [brackets].

QuestionWhat to answer
Server nameWhat players see in the list.
MapA number from the list, or a mod map's folder name. Everyone joins on this map.
Who can join?2 (other computers). On a VPS, always 2.
UDP portEnter keeps 47800.
Most players / cars eachYour limits (up to 64 players, 10 cars each).
Updates per second30, 50 or 60. Enter keeps 50. More is smoother but uses more upload.
PasswordEmpty for an open server. Only a scrambled (hashed) copy is saved.
List it publicly? (Y/N)Y to show up in every player's Public tab.

When it's done, it starts the server, makes it start again after a reboot, and opens the port in the VPS's own firewall.

7

Open the port at your provider

Many providers also have a firewall in their web panel (“firewall”, “security group”, “network rules”). Allow UDP 47800 there, incoming. If your provider has no such panel, skip this.

8

Check it's running

Bash · on the VPS
beamonline status

“The server is running.” If you answered Y to the public list, the log shows public server list: listed as … within a minute, and your server is in everyone's Public tab.

9

Go public later Optional

Said N at setup? Turn the public list on (or off) any time:

Bash · on the VPS
beamonline public on

Not listed? beamonline logs says why. It's almost always the port in step 7.

Your server is live.

Friends find it in the Public tab, or add it with your VPS's address: YOUR_VPS_IP:47800.

Day to day

Everyday commands

Type these on the VPS. They ask for your password when they need to.

CommandWhat it does
beamonline restartRestart the server, for example after changing settings.
beamonline stop · beamonline startStop it (players are told) or start it.
beamonline statusWhether it's running, and its latest log lines.
beamonline logsWatch the log live. Ctrl+C stops watching, not the server.
beamonline settingsEdit the settings file (each setting says what it does). It's checked, then the server restarts.
beamonline setupAnswer the setup questions again.
beamonline versionWhich version is installed.
beamonline public on · offShow it in the public list, or not.
beamonline helpAll of these.
Bash · update: upload the new installer as in step 3, then (settings and identity are kept)
beamonline update
Bash · remove it (asks before deleting its data)
sudo bash beamonline-server-install.sh --uninstall