Skip to Content
Enderdash

Update, rotate, move, or remove an agent

Maintain an installation without confusing the server record, agent key, and runtime state.

Before a change

Keep an independent way to reach the runtime, such as its original console or host service manager. Record the installed artifact, configuration path, and startup overrides. Save a copy of the configuration securely.

Only an owner or admin can rotate the agent key or remove the server record. Changes to runtime files also require host access.

Update a plugin or standalone binary

On supported plugin runtimes, run enderdash update in the console. A player with the enderdash.admin permission can also run /enderdash update in game, except on Hytale. The agent downloads the update and keeps it for the next restart. Restart the runtime during a suitable maintenance window.

You can also start an update from the dashboard. As an owner or admin, open the server's General settings. In the Agent card, choose View updates, then Check for updates.

For a standalone executable, automatic updates download a matching binary beside the executable and verify its SHA-256 checksum. Restart the process to apply it.

With autoUpdate: false, the agent only checks for a new version at startup and writes it to the log. It downloads nothing until you run enderdash update or start the update from the dashboard. You can also stop the process and replace the artifact from Setup manually.

After restart, confirm Online, verify the version in runtime information, and open a live panel. Keep a compatible previous artifact available for recovery.

Update a container installation

Replace the image through Docker, Podman, or your Kubernetes deployment workflow. Container installations disable automatic executable downloads by default.

Retain the data volume and key Secret. Review the image tag or digest before replacement, then confirm live data. For Helm, keep your reviewed values when upgrading.

Rotate an agent key

  1. Open the server's Setup page. You can also choose Open setup in the Agent card of the server's General settings. In Copy your agent key, choose Regenerate key, then Yes, regenerate.
  2. Copy the new key now. Enderdash shows it only once. Share it only through a private channel.
  3. On a plugin runtime, run enderdash install <agentKey> with the new value.
  4. For a file-based standalone setup, replace agentKey and restart the agent.
  5. For environment-based installations, update the service environment or container Secret and recreate or restart the process.
  6. Verify Online and a live operation.

The old key stops working when you confirm. A connected agent disconnects until it has the new key. If a file change has no effect, check JVM and environment overrides. Rotating the record's key alone does not update those values.

Rename a server

  1. As an owner or admin, open the server's General settings.
  2. In Identity, change Server name. Use lowercase letters, numbers, and hyphens only.
  3. Choose Rename server.

The name is part of the server URL. After a rename, old links and bookmarks to the server stop working. Share the new links with your team. The agent key does not change.

Move a server record to another host

Stop the old agent before starting the replacement. Install the correct artifact on the destination, provide this record's key, and verify the reported host or runtime details.

Do not leave two agents running with the same key. To manage two independent runtimes, create two records with separate keys. A record migration does not copy game worlds, container volumes, or application data.

Remove an installation

  1. Stop the runtime or agent service.
  2. Remove the Enderdash jar, executable, container, or deployment that starts the agent.
  3. Remove stored keys from the configuration, environment, and secrets used by that installation.
  4. Decide whether to retain local agent history and data volumes before deleting them.
  5. As an owner or admin, remove the server record if the team no longer needs it. Open the server's General settings and choose Delete server in Danger zone. Read the list of data that Enderdash deletes, type the server name to confirm, and choose Delete server.

Deleting the record also deletes its alert rules, status history, audit and activity history, chat channels, member access, and status page entries. You cannot undo it. The agent key stops working at once.

Removing the record does not uninstall the runtime agent. Removing the agent does not remove the dashboard record. For Kubernetes, remove only resources owned by the chosen Helm or Kustomize installation.

If the replacement will not connect, follow offline recovery.

Was this page helpful?

Send a quick note if anything is missing or unclear.

Last updated on