Skip to content

Configuration reference

Full reference for config.yml: every key, its type, and default value.

8 min read

The local bootstrap file

ReplayCore generates plugins/ReplayCore/config.yml on first start. A fresh customer file contains exactly license-key and server-name. The recording key is the secret shared by your network; the friendly server name identifies this installation in the dashboard.

Container hosts can supply the same two values as REPLAYCORE_LICENSE_KEY and REPLAYCORE_SERVER_NAME. A non-blank environment value takes precedence over the file.

Complete fresh-install config.yml
license-key: "rck_v1_..."
server-name: "EU Hub 1"

Dashboard-managed settings

Open Configuration Studio to manage recording, arena, performance, storage, privacy, death-cam, clips, anti-cheat, replay-browser, messages, menus and supported integrations. Settings can inherit from the workspace or a server category, with explicit server overrides where needed.

The schema names whether a change applies live or requires a recorder restart before you save. Local-only secrets, executable commands and network topology are shown as local controls and cannot be published in a remote configuration document.

Private state and safe delivery

ReplayCore creates a private identity, configuration credential, registered binding and authenticated last-known-good managed configuration in plugins/ReplayCore/. Preserve the whole folder across restarts, upgrades and container recreation, and never copy that private state between two live servers. A live clone prints Recording is DISABLED. [RC-ID-409] and that copy records nothing.

Published settings are authenticated, versioned and validated before application. Invalid, stale, unauthorised or damaged remote data never replaces the last-known-good configuration. Configuration Studio shows delivery and acknowledgement state for each server.

Older installations

Existing explicit server-id and old cloud credential fields remain supported so an upgraded server can keep its established identity and behaviour. They are compatibility inputs only. Do not add them to a fresh config or a new container egg.

Validation and application

Configuration Studio validates types, ranges, platform support and sensitive changes before publication. The recorder independently validates the signed bundle before applying it, and an invalid update leaves the previous authenticated configuration active.

The dashboard identifies settings that apply live and settings that require a recorder restart. Preserve the plugin data folder during that restart so the private identity and last-known-good configuration remain intact.