Getting started

Install the agent

The agent (Servitium Monitor) connects your game machine to Servitium. One command installs it on Windows or Linux and registers the machine as a host in your Center.

Requirements

  • A VPS or dedicated machine that you control.
  • Windows: Windows Server 2019 or newer, or Windows 10/11, with administrator access.
  • Linux: Debian 11+, Ubuntu 20.04+, or RHEL/Fedora with apt or dnf, with root or sudo access.
  • Outbound internet access: the agent talks to Servitium over HTTPS. You do not need to open any inbound port for the panel.
  • Your Servitium account email and password.
Shared hosting

Shared game hosting (a rented slot in a hosting panel without system access) is not supported. The agent needs to run as a background service on the machine.

Install on Windows

  1. Right-click the Start menu and choose Windows PowerShell (Admin) or Terminal (Admin).
  2. Paste the command below. The Center install page shows it with your own email already filled in. Replace the example address if you copy it from here.
  3. PowerShell asks for the password of your Servitium account. Type it and press Enter.
PowerShell (Admin)
iwr -useb https://api.servitium.org/downloads/client/v1/setup.ps1 -OutFile $env:TEMP\setup.ps1; & $env:TEMP\setup.ps1 -Email your-email@example.com

The installer downloads the agent (about 76 MB) and takes about 3 to 5 minutes on a fresh machine.

Install on Linux

  1. Connect to the machine over SSH and make sure you can use sudo (or log in as root).
  2. Run the command below.
  3. The installer asks for your Servitium email and password interactively. It is the same account as the Center.
Bash
curl -fsSL https://api.servitium.org/downloads/client/v1/setup.sh | sudo -E bash

On a fresh machine this takes about 2 to 4 minutes.

What the installer does

On Windows, the installer:

  • Downloads the agent into its own folder.
  • Installs the Visual C++ runtime and the DirectX runtime components that Conan Exiles needs, if they are missing.
  • Adds a Windows Defender exclusion for the agent folder.
  • Registers the machine with your account.
  • Installs the Servitium Monitor Windows service. It starts with Windows and restarts by itself if it stops.

On Linux, the installer:

  • Installs the system packages the agent and SteamCMD need (apt or dnf).
  • Downloads the agent and registers the machine with your account.
  • If the ufw firewall is installed, allows the agent to open game ports automatically.
  • Creates the servitium-monitor systemd service, enabled at boot.

The installer is safe to run again: it updates the agent in place and keeps the identity of your host.

Check that the host appears

In the Center, open Admin, Hosts. Your machine should appear within about 30 seconds. On the install page, Check for my host watches for it for about two minutes and confirms when it is connected.

If it does not show up, check the service on the machine:

PowerShell (Windows)
Get-Service ServitiumMonitor
PowerShell (Windows)
Get-Content C:\Servitium\logs\service-*.log -Tail 50
Bash (Linux)
sudo systemctl status servitium-monitor
Bash (Linux)
sudo journalctl -u servitium-monitor -f

Once the host is online, choose Add game server on the Hosts page to attach your server. More fixes are in FAQ and troubleshooting.

Updating the agent

To update the agent, run the same install command again. It replaces the program, keeps your settings and the host identity, and restarts the service. Your game servers and their files are not touched.

Uninstalling

On Windows, run the uninstaller from an administrator PowerShell. It removes the service, stops the game servers it was running, deletes the agent folders and removes the firewall rules it created. Your game server files are kept unless you add -WipeServers (and -WipeSteam to also remove SteamCMD).

PowerShell (Admin)
iwr -useb https://api.servitium.org/downloads/client/v1/uninstall.ps1 -OutFile $env:TEMP\uninstall.ps1; & $env:TEMP\uninstall.ps1

On Linux, stop and remove the service and the agent program:

Bash
sudo systemctl disable --now servitium-monitor
sudo rm /etc/systemd/system/servitium-monitor.service /opt/servitium/servitium-monitor
sudo rm -f /etc/sudoers.d/servitium-monitor
sudo systemctl daemon-reload

Finally, in the Center, open the host under Admin, Hosts and use Delete this host. Servers assigned to it become unassigned but are not deleted. If the agent is still running somewhere, it registers again on its next connection.

Need a hand?

Still stuck or missing something?

Write to us, we read every message. You can also start free and explore the Center at your own pace.