Configuration Reference

The LeavePulse Agent uses a leavepulse-verified.yaml (or .toml / .json) file to store state and settings. Most fields are automatically populated after running the /leavepulse connect command.

Core Parameters

Key	Type	Default	Description
`enabled`	boolean	`true`	Enable/disable the Agent and metrics reporting.
`server_id`	long	`0`	Unique Server ID from the LeavePulse catalog.
`project_id`	long	`0`	ID of the project the server belongs to.
`environment_id`	long	`0`	Registered environment ID (set after `enroll`).

`ingest` Section (HTTP)

Used for initial metrics reporting and player join/leave events via REST API.

base_url: https://api.leavepulse.com — API address.
interval_seconds: 0 — Periodic send interval (0 to disable, gateway has priority).
send_on_player_events: true — Instant send on player join/leave.
event_min_interval_seconds: 8 — Debounce protection for frequent events.
buffer_max_mb: 10 — Disk buffer size for offline metrics storage.

`gateway` Section (WebSocket)

Primary channel for live features (whitelist, commands, real-time sync).

ws_url: wss://api.leavepulse.com/agent/ws — Gateway address.
reconnect_max_seconds: 30 — Maximum reconnect delay.
bootstrap_stable_seconds: 12 — Time required for a stable connection before team sync (e.g., LuckPerms) starts.

Telemetry (`telemetry`)

Defines how often the Agent collects and sends various data types.

warm_interval_seconds: 30 — High-churn data (TPS, RAM, player counts).
cold_interval_seconds: 300 — Stable data (Minecraft version, plugins).
static_interval_seconds: 1800 — Static data (JVM info, OS).

Proxy Relay (`backend_relay`)

Settings for Velocity or BungeeCord to relay data for backend servers without individual Agents.

enabled: true — Enable relay mode.
auto_match: true — Automatically match backend names to LeavePulse servers.

mapping: Manual mapping if names differ.

yaml

mapping:
  lobby_01: 12345
  survival_pro: 67890

In-Game Auth (`game_auth`)

Useful for offline-mode servers as an extra security layer (PIN code).

enabled: false — Enable PIN request on join.
trust_minutes: 30 — IP trust duration after successful login.
kick_on_timeout_seconds: 60 — Time to enter PIN before kick.

Auto Update (`auto_update`)

channel: stable — Update channel.
auto_download: true — Automatic downloads.
apply_on_restart: true — Install on next restart.
allow_major: false — Whether to allow automatic major version jumps.

Join Notifications (`linking.join_notify`)

enabled: false — Remind unlinked players to link their account on join.
mode: always or whitelist_only.
delay_seconds: 3 — Delay before showing the message.