RAT 5 Server Getting Started

What the server does

RAT 5 Server hosts the HTTPS API that the RAT 5 Client connects to. It also stores RAT data locally and can manage a 7 Days to Die dedicated server install for you.

By default, the server listens on:

https://localhost:7443

That default is local-only. If you want other machines to connect, change the bind address and open the port.

Start the server

Before starting the server for the first time:

Copy config.example.toml to config.toml.
Review the paths and settings in config.toml.
Start the server from its install folder.

Windows

.\rat5-agent.exe --config .\config.toml

Linux

./rat5-agent --config ./config.toml

On first start, RAT 5 Server will create its local data folder and, with the default config, generate its TLS certificate automatically.

If the server has no enabled Owner account, startup also prints a one-time owner bootstrap token to the RAT server console.

First-time setup

Whenever RAT 5 Server has no enabled Owner account, it enters owner bootstrap mode.

The normal first-run flow is:

Start RAT 5 Server.
Read the owner bootstrap token printed in the RAT server console.
Open RAT 5 Client on any machine that can reach the server.
Connect the client to the server URL, such as https://localhost:7443, https://192.168.1.50:7443, or your remote hostname.
When prompted, enter the bootstrap token and create the new Owner account.

After an enabled Owner exists, normal login is available again and the printed token is no longer usable.

If you want other machines to connect

The default server bind is 127.0.0.1:7443, which means only the local machine can reach it. To allow LAN or remote clients:

Change http.bind in config.toml to a reachable interface and port.
Open that port in the host firewall.
If users are outside your LAN, forward that port through your router or use a VPN/private network.
Point client connection profiles at the server's hostname or IP, such as https://rat5-server:7443.

Diagnostics mode

The current diagnostics flag is --diag.

Use it when you want RAT 5 Server to collect a support bundle while it runs and write that bundle when the process shuts down.

Basic example

Windows

.\rat5-agent.exe --config .\config.toml --diag

Linux

./rat5-agent --config ./config.toml --diag

When the server stops, RAT writes a diagnostics bundle zip file. By default, bundles are written under:

<data_dir>\diagnostics\support

or on Linux:

<data_dir>/diagnostics/support

Useful diagnostics options

Option	What it does
`--diag`	Enables diagnostics collection and writes a support bundle on shutdown.
`--diag-dir <path>`	Writes diagnostics bundles to a specific folder instead of the default support folder under the data directory.
`--diag-exit-after <duration>`	Starts in diagnostics mode, then shuts down automatically after the given duration so the bundle is finalized.

Example:

Windows

.\rat5-agent.exe --config .\config.toml --diag --diag-dir .\tmp\support --diag-exit-after 10m

Linux

./rat5-agent --config ./config.toml --diag --diag-dir ./tmp/support --diag-exit-after 10m

Common first-run notes

Client connection profiles must use an https:// base URL.
On a private or self-signed setup, the client usually uses TOFU trust mode.
If you lose every enabled Owner account later, restart RAT 5 Server and use the newly printed bootstrap token to create a replacement Owner account.

Release-package uninstall behavior

Current packaged RAT server releases ship uninstall helpers that distinguish between a standard uninstall and a purge uninstall.

Standard uninstall removes RAT-created service registrations and packaged RAT server files while preserving config.toml and RAT data unless you explicitly request purge cleanup.
Purge uninstall also removes RAT-owned config.toml and RAT data from the RAT install root.
Neither mode ever uninstalls, modifies, or removes the 7 Days to Die game-server installation or any of its files/data.