Skip to content

Watch Page

JonathanLA edited this page Nov 11, 2026 · 1 revision

Watch Page

New in 2.3.0. A web page, served by your dedicated server, where staff can watch the server without logging into the game: a live map of every player, each player's health, biome, ping, equipment and inventory, the server's activity, and kick / ban / seal buttons.

It is off by default and needs one extra network port from your host.

What you see

Part Shows
Map The world's biomes, drawn from the seed, with every online player as a dot (gold = owner, blue = moderator, white = player, red = dead). Drag to move, scroll or + / − to zoom, ⤢ for the whole world, ◎ to follow the selected player. The corner shows the coordinates under the cursor. This is not the explored in-game map: that only exists in each player's game.
Players online Name, role, sealed / dead badges, biome and a health bar.
Player Health, biome, position, ping, strikes, time online, what they hold and wear, and their whole inventory (refreshed every few seconds while you look at them).
Activity Everything ServerGuard posts to Discord — joins and leaves, deaths, shouts, raids, violations, admin actions — plus builds and destroys, with filters. It keeps the last 500 events since the server started, and works even without Discord webhooks.
Actions Kick, Ban (1 hour to permanent), Seal inventory and Unseal, with a reason. Each one runs the matching sg command as you and is posted to the admin channel.

Positions and health update every 2 seconds. The inventory needs ServerGuard 2.3.0 or later on that player's game; with an older version the page says so and shows everything else.

Resizing (2.4.0). Drag the thin dividers between the panels (they light up gold under the mouse) to make the map, the activity feed, the side column or the player list bigger or smaller. Arrow keys work on a focused divider, and a double-click resets that one. The sizes are remembered on that device; ⇲ in the header resets them all. On a phone the panels are stacked instead.

Join requests

2.4.0. When the whitelist is in notify or enforce mode, a player who is not on it becomes a join request. The page tells you at once:

  • a Join requests panel appears at the top of the side column, with Approve and Dismiss buttons;
  • the Access tab and the browser tab title show the number waiting, e.g. (2) ServerGuard Watch;
  • a pop-up appears in the corner. Click 🔕 in the header to also play a short sound.

Approve puts the player on the whitelist; their next login gets in. Dismiss removes the request; if they try again, they show up again. Both are posted to the admin channel under your name.

Access tab

2.4.0.

  • Join requests, with the current whitelist mode and, when players who have joined before are not listed, an Add them all button.
  • Whitelist: everyone on it, with a filter, a form to add a SteamID with a note, and Remove.
  • Bans: every active ServerGuard ban with its reason and end date, a form to ban a SteamID for 1 hour to permanently, and Unban.

Moderators can use all of it (unless watchPageActions is off).

Config tab (owners)

2.4.0.

Owners can edit three files from the page: Settings (settings.yaml), Allowed mods (allowed_mods.yaml) and Moderators (moderators.yaml). You never see raw YAML:

  • Settings are grouped (Access, Enforcement, Strikes, Mod check, Anti-cheat, …) and searchable. Each has a plain-language explanation and the right control: a switch, a number box with its allowed range, choice buttons, or a list where you add and remove entries. A changed setting is highlighted, with Undo and Use default links. Bad values are flagged as you type, and the save button stays disabled until they are fixed.
  • Allowed mods shows the four lists (required, allowed, moderator-only, banned) as rows: mod GUID or name, an optional SHA-256 pin, and a note (written as a comment in the file). Paste a list takes the mods_for_allowed_mods.yaml snippet from a player's PC, an old allowed_mods.yaml, or a plain list.
  • Moderators lists SteamIDs with the name the server knows and a note. Owners are shown but can only be changed in owners.yaml on the server, on purpose.

Saving opens a summary of what will change. The server then:

  1. refuses if someone changed the file since you opened it (reload and redo the change);
  2. checks every value again, and names any that are wrong;
  3. rewrites only the entries that changed, so comments and everything else in the file stay as they were;
  4. reads the result back and writes nothing if it doesn't match exactly;
  5. keeps the previous file as settings.yaml.bak (or allowed_mods.yaml.bak, moderators.yaml.bak), writes the file and reloads it straight away;
  6. posts the list of changes to the admin channel under your name.

Owners and the files they can edit are checked again on the server for every save. To take the editor away entirely, set watchPageConfigEditor: false in settings.yaml (you can't turn it back on from the page).

Setup

  1. Get a port. Ask your host for an extra TCP port for the server. On DatHost the server already has one, custom1, shown in the control panel. If you host the server yourself, forward a TCP port on your router.
  2. Turn it on in conf/settings.yaml (it hot-reloads, no restart needed):
    enableWatchPage: true
    watchPagePort: 20871                               # your extra port
    watchPagePublicUrl: http://your-host.example:20871/  # only used in messages
    The server log and the admin channel confirm Watch page listening on 0.0.0.0:20871.
  3. Make yourself a key. In game, as an owner or moderator, press F5 and type sg watch key. Optionally add a label: sg watch key laptop. The key appears once in the console and is copied to your clipboard.
  4. Open the page at the address from step 2 (type http://, not https://), paste the key, and tick Remember on this device if it is your own computer.

Each staff member makes their own key, so the admin channel shows who did what. A key stops working the moment its owner is removed from owners.yaml / moderators.yaml.

Commands

Command What it does
sg watch Status: on/off, the address, whether actions are allowed, how many keys exist.
sg watch key [label] Create a personal key for yourself. Shown once.
sg watch keys Your keys (owners see everyone's), with when and from where each was last used.
sg watch revoke <id|all> Cancel a key at once. Moderators can revoke their own keys, owners anyone's.

Keys are stored in conf/watch_keys.yaml as hashes only. Deleting an entry there also revokes it.

Settings

Setting Default
enableWatchPage false Master switch.
watchPagePort 0 The TCP port. 0 = not set, the page stays off.
watchPageBindAddress 0.0.0.0 Which network address to listen on. Leave it unless your host says otherwise.
watchPagePublicUrl empty The address staff open. Only used in sg watch and Discord messages.
watchPageAllowedIps [] Optional list of IP addresses allowed to open the page. Empty = any address with a valid key.
watchPageActions true false = watch only: no kick, ban, seal or whitelist buttons.
watchPageConfigEditor true Owners can edit settings, allowed mods and moderators on the page. false = the page never writes those files.

Security

The page runs over plain HTTP: game hosts don't give you a certificate for that port, so your key is not encrypted on its way to the server. Someone on the same network as you — public Wi-Fi, for example — could read it. To limit the risk:

  • Keys are long and random (125 bits) and personal. Revoke a key (sg watch revoke <id>) if you think it was seen, and make a new one.
  • If your staff have fixed IP addresses, list them in watchPageAllowedIps.
  • After 10 wrong keys from one address within 10 minutes, that address is blocked for 15 minutes and the admin channel is told.
  • The first time a key is used from a new address, the admin channel gets "Watch page opened by … from …". An address you don't recognise means the key leaked.
  • Every kick, ban, seal, whitelist change and config edit from the page is posted to the admin channel with your name. Set watchPageActions: false for a watch-only page, and watchPageConfigEditor: false to keep the files out of reach.
  • Only owners can edit the configuration; a moderator's key can't, even by calling the server directly.

Troubleshooting

  • The page doesn't load. Check the server log for Watch page listening on …. If it says could not listen, the port is wrong or taken. If it is listening but the browser times out, your host isn't forwarding that port. Make sure you typed http://.
  • "Unknown or revoked key." The key was revoked, mistyped, or its owner is no longer staff.
  • "Too many wrong keys from your address." Wait 15 minutes.
  • The map says "Generating the map…". It is drawn once, a few seconds after the first visit following a server start.
  • No inventory for a player. Their game runs a ServerGuard older than 2.3.0.
  • "… changed on the server since you opened it." Someone (or ServerGuard itself) edited the file after you loaded it. Reload, then make your change again.
  • A panel is too small or gone. Click ⇲ in the header to reset the sizes.

Clone this wiki locally