Install an Agent

Use this guide when

Use this page when you need to:

• install EnderDash on a new runtime
• reinstall after rotating an agent key
• move a server record to a different runtime

Before you begin

You need:

• an active subscription on the organization
• a server record in Servers
• owner or admin access, because Downloads and agent-key management are admin-only

Pick the correct download

Open Downloads, select the server record, and choose the build that matches the runtime:

Do not reuse a Bukkit build on a proxy or a standalone host. The runtime must match the artifact.

Install the runtime package

Plugin and proxy runtimes

1. Place the downloaded jar in the runtime's plugins/ directory.
2. Start or restart the runtime once so the EnderDash config and console command are available.
3. Run enderdash install <agentKey> in the console.

Standalone runtimes

1. Place the standalone artifact in the directory where it will run.
2. Save the agent key in ~/.enderdash/config.yml.
3. Start the standalone runtime.

Reinstall after a key rotation

If Downloads shows a fresh agent key, the previous key is no longer valid for that server record.

• On runtimes with the command surface, run enderdash install <agentKey> again.
• On standalone or manual setups, replace the old agentKey value in the config file and restart.

Manual fallback

If the runtime does not expose the enderdash console command, set the key manually in the local config:

agentKey: "<agentKey>"
signalingUrl: "wss://signaling.enderdash.com/ws"

Use signalingUrl only if you need to override the default signaling host.

Verify the result

The install is complete when:

• the server shows Online
• the server page opens without setup prompts
• live panels begin loading data

If the runtime starts but EnderDash still shows the server as offline, continue with Recover an Offline Server.

Related pages

• Agent Commands
• Network Requirements
• Connection Model