Update, rotate, move, or remove an agent

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 from the console. The agent stages an update for the next restart. Restart the runtime during a suitable maintenance window.

For a standalone executable, automatic updates stage a matching binary beside the executable and verify its SHA-256 checksum. Restart the process to apply it. If automatic updates are disabled, 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 and use its key regeneration control.
2. Copy the new key 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 no longer authenticates. If a file change has no effect, check JVM and environment overrides. Rotating the record's key alone does not update those values.

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.

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.