Skip to content

Deploy a production server

Download the server package through developer access for your host:

Platform Archive
Windows x64 revo-server-<version>-release-win64.zip
Linux x64 revo-server-<version>-release-linux.zip

Install the required runtimes and extract the whole package into a folder of your choice. The examples below use C:\Revo\server on Windows and /srv/revo/server on Linux.

Deploy your built server scripts and their runtime dependencies beside the server package. A typical layout is:

server/
revo-server.exe
lib/
config.toml
resources/
server/
index.js
package.json
node_modules/
secrets/
resources.key
.api/
logs/

On Linux, the executable is revo-server. The .api and logs directories hold registration state and runtime logs.

First publish the client resources to your resource host. Copy the same resources.key used for publishing into secrets/ on the game server.

This example uses a JavaScript server entry, CDN-hosted resources and embedded voice. Use it as the instance’s config.toml:

name = "Example #1"
language = "en"
port = 27015
max_players = 32
[api]
enabled = true
project_secret = "YOUR_PROJECT_SECRET"
public_host = "play.example.com"
state_file = ".api/data.json"
[resources]
mode = "remote"
url = "https://cdn.example.com/resources/"
key_path = "secrets/resources.key"
release = "MANIFEST_SHA256"
[resources.http]
enabled = false
[scripting.js]
entry = "resources/server/index.js"
[voice]
enabled = true
mode = "embedded"
media_port = 27017

Replace the credential, public host, resource URL and manifest hash with your values. MANIFEST_SHA256 is the 64-character hash printed by resource-tool when publishing. Pinning it makes restarts load the same resource release. Set max_players to the capacity you have tested with your game mode. See Hosting and hardware for starting allocations and the recorded load baseline.

The registration guide covers the project credential and join code. Follow the networking guide to open the game and voice ports. For a separate voice process, use the external voice configuration.

The server reads config.toml from its working directory. Relative script, key and state paths are resolved from there too.

On Windows:

Terminal window
Set-Location C:\Revo\server
.\revo-server.exe

On Linux:

Terminal window
cd /srv/revo/server
./revo-server

Check the registration message and Server is now running on port 27015. Then connect through the assigned join code from another network. Verify the loading screen, resource downloads, login or spawn flow and voice if enabled.

Press Ctrl+C and wait for the process to exit before starting it under a service manager.

The service account needs read and execute access to the package, read access to configuration and keys, and write access to .api, logs and any files saved by your game mode. Create these writable directories before starting the service.

Create an unprivileged account named revo, grant it the permissions above, and save this unit as /etc/systemd/system/revo-server.service:

[Unit]
Description=Revo game server
Wants=network-online.target
After=network-online.target
StartLimitIntervalSec=300
StartLimitBurst=3
[Service]
Type=exec
User=revo
Group=revo
WorkingDirectory=/srv/revo/server
ExecStart=/srv/revo/server/revo-server
Restart=on-failure
RestartSec=10
KillMode=mixed
TimeoutStopSec=30
UMask=0077
[Install]
WantedBy=multi-user.target

WorkingDirectory keeps file resolution consistent with the foreground run. KillMode=mixed sends the initial stop signal to the main process, allowing it to finish its shutdown work. These options are described in the systemd execution, service and shutdown references.

Load the unit and start it:

Terminal window
sudo systemctl daemon-reload
sudo systemctl enable --now revo-server
sudo journalctl -u revo-server -f

To stop it for maintenance:

Terminal window
sudo systemctl stop revo-server

Install a WinSW 2 distribution compatible with your installed .NET runtime. Rename its executable to revo-server-service.exe and place it in C:\Revo\server.

Save revo-server-service.xml beside it:

<service>
<id>RevoServer</id>
<name>Revo game server</name>
<executable>%BASE%\revo-server.exe</executable>
<workingdirectory>%BASE%</workingdirectory>
<startmode>Automatic</startmode>
<serviceaccount>
<domain>NT AUTHORITY</domain>
<user>LocalService</user>
</serviceaccount>
<logpath>%BASE%\logs</logpath>
<log mode="roll" />
<stoptimeout>30 sec</stoptimeout>
<stopparentprocessfirst>true</stopparentprocessfirst>
<onfailure action="restart" delay="10 sec" />
<onfailure action="restart" delay="20 sec" />
<onfailure action="none" />
<resetfailure>5 min</resetfailure>
</service>

Grant the LocalService account the file permissions described above. WinSW uses the matching XML filename, sets the working directory and sends Ctrl+C when stopping a console application. See its installation guide and configuration reference.

From an administrator PowerShell session:

Terminal window
Set-Location C:\Revo\server
.\revo-server-service.exe install
.\revo-server-service.exe start
.\revo-server-service.exe status

To stop it and wait for shutdown:

Terminal window
.\revo-server-service.exe stopwait

Both examples allow 30 seconds for process shutdown. The server gives asynchronous JavaScript serverStop handlers up to 10 seconds to finish. See server startup and shutdown for awaiting saves and connection cleanup.

After service startup, check the server’s logs directory and repeat the connection check. If repeated startup failures exhaust the restart attempts, fix the logged error before starting the service again. For systemd, run sudo systemctl reset-failed revo-server before restarting it.

Keep a record of the deployed server version, game-mode build and pinned resource manifest hash. Before an update:

  1. Prepare the new server package and game-mode build in a separate folder.
  2. Publish the matching client resources and record their manifest hash.
  3. Stop the running service and wait for shutdown to complete.
  4. Back up config.toml, .api/data.json, resource keys and persistent game-mode data. Include the database if the update changes its schema.
  5. Deploy the new server scripts, binaries and bundled libraries together. Keep the instance’s registration file, keys and local settings, and set resources.release to the new hash.
  6. Start the service and repeat the connection check.

Preserve the previous binaries, scripts, configuration and resource release until the update is verified. To roll back, stop the service, restore that combination and start it again. Coordinate database restoration with any schema changes made by the game mode.

Client selection follows the server’s compatibility generation. A binary rollback must still be within the supported compatibility window. The resource rollback guide covers retained resource releases and the resource-tool commands.