Agent Setup

Overview

This is the normal setup path for connecting a server or host target to EnderDash. The current setup flow lives in the Downloads page inside your organization, not in a separate global API key screen.

Supported targets

Minecraft servers

Bukkit, Spigot, Paper, Purpur, and Folia through EnderDash-Bukkit.jar
Hytale through EnderDash-Hytale.jar

Proxies

Velocity through EnderDash-Velocity.jar
BungeeCord and Waterfall through EnderDash-Bungeecord.jar

Standalone host setups

standalone host setups through the EnderDash-Standalone packages

Pick the build that matches the thing you are connecting. Do not reuse the Bukkit jar for a proxy or standalone host.

Before you install

Required access and setup state

your organization has an active subscription
the server record already exists in Servers
you are an organization owner or admin, because Downloads and API key rotation are admin-only

API keys are scoped per server record

Each EnderDash server record has its own API key. If you create two server records, they do not share keys.

Standard install flow

Open Downloads

Open your organization in EnderDash, then go to Downloads.

Select the server and build

Choose the server you want to connect and download the agent build that matches that target.

Place the build correctly

Put the file in the correct location for that platform. For Minecraft servers and proxies, the jar normally goes in the platform's plugins/ directory.

Start the target once

Boot the server or host so the command and config are available.

Install the API key

Run enderdash install <apiKey> in the server console.

Confirm the connection

Refresh EnderDash and make sure the server shows as online.

Manual configuration

Minimum config

If you cannot use the install command, you can still set the key manually. The exact config path depends on the platform, but the important fields look like this:

apiKey: "your-api-key"
signalingUrl: "wss://app.enderdash.com/api/signaling"

the server shows Online in Servers
the server page opens normally
live panels such as Console, Info, or Players begin loading data

If the agent started but the server still looks offline

If the agent starts but EnderDash still shows the server as offline, continue with Connection Setup.

Common mistakes

Members cannot finish setup

The install flow depends on Downloads and key management, which are owner or admin features.

Installing the wrong build for the target platform
Copying an API key from a different server record
Rotating the key in Downloads and forgetting to update the running agent
Starting the server but never running enderdash install <apiKey>
Expecting members to see setup details even though Downloads is admin-only

Was this page helpful?

Send a quick note if anything is missing or unclear.