Plugin config.yml reference

After the first server restart with the clan.me plugin installed, a configuration file is created at plugins/clan_me/config.yml. This file controls how the plugin behaves. Only plugin_token is required; everything else has a sensible default.

File location

plugins/
  clan_me/
    config.yml   ← edit this file

Changes to config.yml take effect after a server restart. The plugin does not support hot-reload.

plugin_token

plugin_token: "paste-your-token-here"

Required. The secret token that identifies your server to clan.me. Find it on the Owner Dashboard under your server's entry. It is a 64-character hexadecimal string.

• If the token is left as the placeholder value or left blank, the plugin skips sending heartbeats but still displays the join notice to players.
• If the token is wrong or revoked, the ingest service returns a 401 and the plugin logs “Heartbeat rejected: invalid plugin token” to the console. No retry is attempted for 401s.
• Never share your token publicly. Anyone with the token can send heartbeats as your server. Regenerate from the dashboard if you suspect it has been exposed.

heartbeat_interval_s

heartbeat_interval_s: 60

How often the plugin sends a heartbeat to clan.me, in seconds. Default: 60. Valid range: 30–120. Values outside this range are clamped to the nearest bound.

• Shorter intervals (30s) give finer-grained TPS and memory charts, and session join/quit times are recorded more precisely. They also produce more database writes.
• Longer intervals (120s) reduce write volume, which matters if you are running many servers on the same clan.me account. Chart resolution is coarser.

The default of 60s is a good balance for most servers. The ingest service rejects heartbeats arriving less than 30 seconds apart regardless of this setting.

expose_plugins

expose_plugins: true

Whether to include your server's installed plugin list in each heartbeat. Default: true.

When enabled, each heartbeat includes the name and version of every plugin currently loaded by Bukkit. This data powers the Plugin List panel and the plugin correlation alert, which fires when a TPS drop coincides with a newly loaded plugin.

• Plugin list data is visible only to you in the owner dashboard. It is never shown publicly.
• If your plugin list is sensitive (for example, you use commercial or private plugins you prefer not to disclose), set this to false. You will still get TPS, memory, session, and all other analytics, just not the plugin correlation alert.

in_game_alerts

in_game_alerts:
  enabled: true

Controls in-game alert delivery to online server operators. When an alert fires, clan.me includes a formatted message in the heartbeat response, and the plugin broadcasts it to any online player with operator status. Alert thresholds and cooldowns are configured in the clan.me dashboard under Settings → Alerts, not in this file.

enabled

Default: true. Set to false to stop the plugin from broadcasting in-game alert messages. Dashboard alerts (email, webhook, browser push) are unaffected by this setting.

ingest_url

ingest_url: ""

Advanced. Override the endpoint the plugin POSTs heartbeats to. Leave blank (the default) to use the production ingest service at https://ingest.clan.me/api/v1/ingest/heartbeat.

The only common use case is local development: if you are running the ingest service locally on port 3001, set this to http://localhost:3001/api/v1/ingest/heartbeat. Do not change this on a production server.