StaffHQ
Docs/Help/Troubleshooting

Troubleshooting

Solutions to the most common problems with the StaffHQ plugin, dashboard, and Discord bot.

If you cannot find a solution here, join the Discord server or email support@staffhq.net.

Tip
Enable debug: true in config.yml before troubleshooting connection issues. This adds detailed logs to the server console including the exact request and response from the dashboard.

Plugin issues

Plugin not connecting to the dashboard

Check the following in order:

  1. Confirm api.endpoint is exactly https://dash.staffhq.net with no trailing slash.
  2. Confirm api.key is a Plugin-type key, not a Dashboard key.
  3. Check that outbound HTTPS (port 443) from your server to dash.staffhq.net is not blocked by a firewall.
  4. Run curl -I https://dash.staffhq.net from the server to test connectivity.
# Test connectivity from server CLI
curl -I https://dash.staffhq.net

Server does not appear in the dashboard

The server only appears after the plugin connects and sends its first heartbeat. Wait up to 30 seconds after a successful plugin start. If it still does not appear:

  • Confirm the plugin loaded by checking for a StaffHQ entry in /plugins in the console.
  • Enable debug: true and restart. Look for the heartbeat log line.
  • Refresh the dashboard (hard refresh with Ctrl+Shift+R).

Staff members not showing up in the Staff panel

Staff detection relies on LuckPerms group membership matching the names in staff-groups in config.yml.

  • Check that group names in config.yml exactly match the LuckPerms group names (case-insensitive, but spelling matters).
  • Run /lp user [name] info to confirm the player's actual group.
  • LuckPerms must be installed on the same server as StaffHQ. Vault alone does not work.

Chat messages are not being logged

Several things can prevent chat logging:

  • Confirm tracking.chat: true in config.yml.
  • Paper 1.21 and later use a new async chat API. Ensure you are running the latest version of the StaffHQ plugin.
  • If using a chat plugin (e.g. ChatControl, VentureChat), it may be consuming the chat event before StaffHQ. Try setting StaffHQ to highest priority, or contact support.

Commands are not being logged

Check the command_blacklist in config.yml. Commands listed there are intentionally excluded. Also confirm tracking.commands: true.

License activation fails

  • Make sure you are using the correct URL: dash.staffhq.net/license/success.
  • Ensure the license key is copied exactly, without leading or trailing spaces.
  • Each license key can only be activated once. If you have already activated it, log in at dash.staffhq.net instead.
  • If the key does not work and you purchased recently, contact support with your order reference.

Discord bot issues

Discord bot is offline or not responding

  • For self-hosted bots: check that the process is running (systemctl status staffhq-bot).
  • Verify DISCORD_TOKEN and STAFFHQ_API_KEY in .env are correct.
  • The API key for the bot must be a Dashboard-type key, not a Plugin key.
  • If Server Members Intent or Message Content Intent is missing from the bot settings, the bot will start but many commands will fail.
  • For managed hosting: re-save the Discord settings page to trigger a bot restart.

Slash commands not appearing in Discord

Commands are registered per guild. After saving your Discord settings in the dashboard, wait up to 1 hour for Discord to propagate the commands. If they still do not appear:

  • Confirm the bot was invited with both bot and applications.commands scopes.
  • Ensure the Guild ID in the dashboard matches the server where the bot is running.

Getting support

If you are still stuck after following the steps above, provide the following when reaching out:

  • Your server software and version (e.g. Paper 1.21.1)
  • StaffHQ plugin version
  • The relevant section of your console log (with debug: true enabled)
  • Your config.yml (redact the API key)
Join DiscordEmail support
← PreviousREST APINext →FAQ