Server Linking
Linking a server to your VoxelBench account brings its reports, test results, profiles and monitoring into your dashboard. This page covers the website side: what linking gives you and how to manage your linked servers. The steps on the server are described in Account Linking.
Linking in Short
- On the server, run
/bench link, in the console or in game (it needs thevoxelbench.linkpermission). The plugin prints an 8-character code and a link, both valid 10 minutes. - Open the link, or go to Dashboard โ Servers โ Link a server, and sign in. Your account's email address must be verified.
- On Link Your Server, the code is already filled in when you came through the link; otherwise type it in Linking Code. Give the server a name if you like (Server Name, optional), then click Link This Server.
- The plugin checks every 5 seconds for 5 minutes, receives the server's link token and saves it in its configuration. If you confirm later than that, run
/bench linkagain.
The server side, with the messages the plugin prints and what to do when linking fails, is in Account Linking. A script or an agent can also confirm a code for you through the API (see API and Tokens).
What Linking Gives You
| Server not linked | Linked server | |
|---|---|---|
| Benchmark reports | Anonymous: anyone who has the link can open it, and it expires after 30 minutes | In your account, private by default, kept 30 days on Free and 1 year on Pro (see Plans & Limits); you can make each one Unlisted or Public |
Single test results (/bench test) | Not sent | Sent when reports.backend.unit-tests is true in the plugin, and kept in your account (see Unit Tests) |
| Custom profile runs | Refused | Kept in your account, without a score, never public |
| Profiles and memory reports | Cannot be uploaded | /bench profile upload and /bench memory upload send them to your account |
| Monitoring and alerts | Not available | Available with a plan that includes monitoring (see Monitoring Overview) |
| Verification and auto-bench | Not available | You can verify the server, then let auto-bench run on it (see Auto-bench on the Website) |
Linking itself is free, on every plan. How long uploads are kept, and what the paid plans add, is in Plans & Limits.
Managing Your Servers
The Servers Page
Dashboard โ Servers lists every server linked to your account, with its badges (Verified or Unverified, Public, Monitoring). From there you can:
- link another server with Link a server;
- sort servers into groups with New group, then Move to group in a server's menu. Groups only organise this list;
- open a server's settings with Manage.
Server Settings
A server's settings page has five tabs:
| Tab | What you do there |
|---|---|
| General | Rename the server (Server Name), choose whether it shows on your public profile and set its icon and banner, and open its Benchmark history: every report and unit test it sent |
| Connection | Server Verification: prove that you control the server at its public address and get the Verified badge (see Server Verification). Plugin connection: the plugin version, its last contact, a fingerprint of the address it connects from, and Revoke plugin token |
| Monitoring | Turn monitoring on or off for this server and follow its setup, open a Public status page & external probe, and see its performance profiles (see Monitoring Dashboard) |
| Notifications | Notify on new report (see New Report Notifications), and once it is on, Notification Email. Discord Webhook URL is always shown, whether Notify on new report is on or not: this server's metric and event alerts post to that webhook, for rules whose Discord channel is on |
| Danger zone | Unlink Server |
New Report Notifications
In the server's Notifications tab, turn on Notify on new report. From then on, each benchmark report the server sends to your account (a run started with /bench) triggers:
- an email with the server name, the mode, the score and rank (or why there is none) and a link to the report. It goes to your account address, or to the Notification Email you enter โ once its owner has clicked the confirmation link we send to it. Until then, it goes to your account address;
- a Discord message on the server's webhook, if one is set in the same tab.
Auto-bench runs are not included (they are reported in the Auto-bench panel), nor are unit tests. Emails and Discord messages go through the same delivery queue as monitoring alerts, with retries. Every email has a link to turn these emails off; you can turn them back on under Account > Notifications > New reports on your servers.
Linking Again, Revoking, Unlinking
- Linking again. On the server,
/bench link forceasks for a new code even though the server already has a token. Confirming it from your dashboard gives the server a new token, removes its verification and its verified address, and sends you an email saying so. Verify the server again afterwards. The API and the Claude connector refuse to link again a server that is already linked to your account: this is done from the dashboard only. - Revoking the plugin token (Connection tab). The plugin is refused from then on, until you link the server again with
/bench link. The server, its reports and its monitoring history are kept. Do it if the token may have leaked, for example when the network fingerprint changes although you did not move the server. - Unlinking (Danger zone tab). The server leaves your account. Its reports and unit test results stay in your account; its monitoring data, events, alert rules and their history, auto-bench targets, uploaded profiles and memory reports are deleted. Future reports from that server are no longer linked to you.
Security
- The 8-character code proves that whoever types it can read the server's console. It is valid 10 minutes and can be used once.
- The link token is a random 64-character hexadecimal string. voxelbench.com hands it over only during the 5 minutes that follow your confirmation, and only to the address that asked for the code. It then keeps only a fingerprint of it, never the token itself.
- The plugin stores the token in
plugins/VoxelBench/config.yml(authentication.token). Never share it: whoever holds it can send data in your server's name. - Monitoring and uploads use the token alone. Benchmark reports and single test results also carry a one-time signature that only official VoxelBench jars can produce, and voxelbench.com refuses a jar it does not know (see How VoxelBench Works).