Skip to content

Instance settings

This page is for the sysop. It shows how to change the policy values of your instance in the app: the game rules, the API limits, how long data is kept, imports and spots, tools and their registries, the imprint, donation links and the update check. At the end the new value applies at once, with no restart.

Before you start

  • A sysop session: your callsign is in ADMIN_CALLSIGNS and control-verified (Who is a sysop). On an instance with an https address, you sign in on that address.
  • Infrastructure and secrets are not here. Addresses, ports, paths, keys and ADMIN_CALLSIGNS stay in the environment (Configuration).

Which value applies

Each instance setting has exactly one source, and the page shows it as a badge:

Badge Where the value comes from What you can do
Default the built-in default change it
Changed here a value saved on this page change it, or Reset to default
Set by the environment the gateway's environment sets the key nothing here: change it in the environment and restart the gateway

The environment always wins. A value you saved here stays stored while the environment overrides it, and the page says so; it applies again once the environment no longer sets the key. The full list of instance settings, with what each accepts, is in Configuration → Instance settings.

Steps

  1. Open Admin in the navigation rail, then the Instance settings group.
  2. Find the setting: open its group (Game rules, Accounts & API, Privacy & retention, Imports & data sources, Federation, Tools, Imprint & contact, Support links, Updates), or type a word into Search admin sections, such as imprint or retention. The search opens every group it matches.

  3. Change the value:

    • A switch or a choice (Look for new releases, Lowest verified tier) saves as you change it.
    • A field saves with Save. A number shows its unit and its range; a list takes one row per entry, with Add a contact or Add a link, and Remove.

  4. Read the result. A saved value shows Changed here with your callsign and the time, and a short message confirms it. A value outside the setting's range shows the reason under the field, and nothing is saved.

To go back to the default, select Reset to default under the setting and confirm.

Tool registries

The Tools group decides which tool registries every player's Tools app lists. Tools run sandboxed in each player's browser and never on the instance; a registry only says which signed tools to offer.

Setting What it does
Registries The registries every player sees. The project registry, bundled with each release, comes first and lists the project's own tools; switch it off to offer only your own. The app ships no tools, so players install every tool from these.
Players may add tool registries Players add their own registries, marked as not checked by this instance. Switched off, those are hidden and not fetched, and stay stored until each player removes them or you switch it on again.
Fetch tool registries through this instance The gateway fetches added registries and their tools and serves them from this instance: players' addresses never reach the registry's host, and cached copies keep working offline. Switched off, browsers fetch registries directly.

To add a registry:

  1. In Tools → Registries, enter its address: github:owner/repo@v1.0.0, a GitHub Pages address or any https:// address, and an optional label.
  2. Select Fetch and show its key, and compare the fingerprint with the one the publisher gives.
  3. Select It matches: pin and add only if every digit matches.

Each row shows whether the registry's file verifies under its pinned key. Key changed means the file is now signed by another key: players see none of its tools until you ask the publisher for the new fingerprint and select Compare and confirm…. Every change lands in the audit log.

TOOL_REGISTRIES in the environment replaces the list, which then shows read-only (Configuration). How registries, keys and the instance's copies work is in How registries work; to run a registry of your own, see Publish a registry.

Check that it worked

  • The setting shows Changed here, and the group's header counts it.
  • Admin → Audit log lists the change with the old and the new value.
  • For the imprint: open /imprint on your instance. It shows your name and address, and no warning.

From a script

The page reads and writes GET /api/admin/settings and PUT / DELETE /api/admin/settings/<KEY>. A script uses them with the operator secret:

curl -X PUT https://<your-host>/api/admin/settings/HIDE_DAILY_LIMIT \
  -H "x-operator-secret: $OPERATOR_SECRET" -H "content-type: application/json" \
  -d '{"value": "10"}'

A key the environment sets answers 409. deploy/aprscaching doctor lists the settings changed here.

Next