Documentation Owners

Owner Guide

Documentation for server owners and moderators connecting Minecraft servers, using the LeavePulse Agent, and managing whitelist flows.

On this page
  1. What the Agent is for
  2. Guides
  3. Who should read this
  4. Developer reference

LeavePulse brings monitoring, player profiles, server ownership, plugin telemetry, Discord-assisted moderation, and whitelist applications into one public product surface.

This owner section is written for server owners and moderators. It explains the product first, keeps low-level API details separate, and links player-facing steps to the Users section.

What the Agent is for

The LeavePulse Agent is the Minecraft-side bridge between your server and LeavePulse. A public server page can exist without it, but the Agent is what proves ownership and unlocks live features: verified telemetry, gateway-backed commands, whitelist enforcement, account linking, maintenance mode, diagnostics, playtime signals, and optional Discord or LuckPerms integrations.

Install it when you want LeavePulse to do more than show a static server listing. The Agent can start unconnected, which is useful for confirming that the jar loads and diagnostics work before linking. The normal setup path is to download from Modrinth, install the artifact, run the platform connect command, then use diagnostics if anything does not connect cleanly.

Guides

  • Getting started: learn the LeavePulse model and the recommended first setup flow.
  • Agent downloads: use Modrinth as the primary source, then verify release channels, platform builds, and checksums with the website card.
  • Plugin install: choose the right Minecraft platform artifact and connect it to the website.
  • Plugin compatibility: compare artifacts, root commands, aliases, and proxy-specific behavior.
  • Plugin configuration: understand the generated config fields without tuning every advanced option.
  • Plugin commands: see the in-game and console commands available to owners, moderators, and players.
  • Diagnostics: export the report that explains gateway, token, network, whitelist, and runtime state.
  • Whitelist: configure application review, enforcement, imports, and moderation.
  • Player account linking: share the player-facing guide when someone needs Minecraft verification help.
  • Troubleshooting: fix common setup and connection issues.

Who should read this

Server owners should focus on the setup, plugin, diagnostics, and configuration guides. Moderators should read the whitelist and command guides. Player-facing instructions live in Users docs.

Developer reference

The public API and OpenAPI schema are separate from these product docs. Use the API reference link in the docs header or footer when you need endpoint-level details.

LeavePulse

A small beginning of a big story

Made with 💛 in Ukraine

© Copyright 2025-2026 LeavePulse - All Rights Reserved. Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.