Skip to content
CerebRUSTCerebRUST Docs

Quick start for server owners

The whole install is one file and one config value. This page is the fast path; each step links to the detail if something does not go as expected.

Before you start

Section titled “Before you start”

You need an Oxide/uMod Rust server you control the filesystem of, and an ingest token. See Prerequisites for the full list, and Get an ingest token for how to obtain one.

1. Download the plugin

Section titled “1. Download the plugin”

Grab Cerebrust.cs. It is a single C# file — there is nothing to compile, and no other dependency.

2. Drop it in

Section titled “2. Drop it in”

Copy it into your server’s plugin folder:

<server>/oxide/plugins/Cerebrust.cs

Oxide compiles it on the spot. It will load, complain that it has no token, and idle — that is expected.

3. Add your token

Section titled “3. Add your token”

Oxide writes a config file the first time the plugin loads. Open it:

<server>/oxide/config/Cerebrust.json

Set your token:

{
  "ApiBaseUrl": "https://api.cerebrust.xyz",
  "IngestToken": "crst_your_token_here",
  "verbose_logging": false
}

4. Reload

Section titled “4. Reload”

From RCON or the server console:

o.reload Cerebrust

Look for this in the console:

CerebRUST ingest initialized.

That line means the token was accepted, your server is bound, and telemetry is flowing.

5. Open the dashboard

Section titled “5. Open the dashboard”

Sign in at app.cerebrust.xyz with the Steam account that owns the token, and your server appears under My servers.

Give it a minute or two before judging it — the map render only uploads when no players are online, and the leaderboard compiles on an hourly job.

Full detail on each step: Install the plugin · Verify it is working · Troubleshooting

What next

Section titled “What next”