Getting Started

Requirements

Before installing StaffHQ, make sure your environment meets these requirements.

• Minecraft server running Paper, Spigot, Purpur, Folia, BungeeCord, or Velocity
• Java 17 or later on the server host
• LuckPerms installed on your server (required for staff group detection)
• A StaffHQ license (Starter, Pro, or Max tier)
• Outbound HTTPS access from your server to dash.staffhq.net

Purchase a license

Licenses are available at staffhq.net. Three tiers are available:

License activation

1. 1

   Complete your purchase

   After checkout you will receive a confirmation email with your license key.
2. 2

   Activate your key

   Visit dash.staffhq.net/license/success and enter your license key to activate it and create your dashboard account.
3. 3

   Log in to the dashboard

   Go to dash.staffhq.net and sign in with the credentials you set during activation.

Generate an API key

The plugin needs a Plugin-type API key to authenticate with your dashboard.

1. 1

   Open Settings

   In the dashboard, click Settings in the left navigation.
2. 2

   Create an API key

   Under API Keys, click "New key". Set the type to Plugin. Give it a descriptive name such as "My Server".
3. 3

   Copy the key

   The key is shown only once. Copy it now and keep it safe.

Install the plugin

1. 1

   Download the jar

   Open the dashboard and go to Settings to get the download for your platform. Use the Bukkit jar for Paper, Spigot, Purpur, and Folia. Use the BungeeCord or Velocity jar on your proxy. The download is tied to your license, so do not share the URL publicly.
2. 2

   Place the jar

   Copy the jar into your server's plugins/ folder.
3. 3

   Start the server once

   Start (or restart) your server. StaffHQ will generate a default config.yml in plugins/StaffHQ/.
4. 4

   Edit config.yml

   Open the generated config and fill in your API key, endpoint, and server name.

Minimal config.yml

api:
  endpoint: "https://dash.staffhq.net"
  key: "YOUR_PLUGIN_API_KEY"

server:
  name: "My Server"

staff-groups:
  - owner
  - admin
  - moderator
  - helper

See the Plugin page for the full configuration reference.

Verify the connection

Restart your server after saving config.yml. Watch the console for a StaffHQ startup message. If the plugin connects successfully you will see:

[StaffHQ] Connected to dashboard (ping 42ms)

Log into the dashboard and check the Servers page. Your server should appear with a green status indicator within a few seconds of the plugin connecting.

What next