Skip to Content
Enderdash

Agent configuration

Configuration locations, current defaults, runtime overrides, and reload behavior.

Configuration locations

RuntimeDefault location
Bukkit-family and BungeeCordplugins/Enderdash/config.yml
Velocityplugins/enderdash/config.yml
HytaleEnderdash's runtime-owned plugin data directory
Standalone Linux and macOS~/.enderdash/config.yml
Standalone Windows%APPDATA%\Enderdash\config.yml

Existing installations move the former mixed-case agent data directory to the new name at startup. Configuration, databases, and console history move together. If the new directory already contains data, both directories stay intact and the agent uses the new directory.

Standalone accepts --config <path> to select another file. A relative path resolves from the process's working directory. Container deployments retain agent state under /enderdash/data; use the installation's mounted volume and environment settings.

Options and defaults

These values are the file defaults. A runtime launcher can override the key and the signaling URL.

OptionTypeDefaultPurpose
agentKeyString""Secret key for one server record. Required for registration.
signalingUrlString"wss://signaling.enderdash.com/ws"Signaling WebSocket endpoint. Keep the default for the hosted service.
autoUpdateBooleantrueDownload new agent versions automatically. A restart applies a downloaded update. false only checks and logs.
debugConnectionLogsBooleanfalseEnable connection lifecycle logs for diagnosis.
debugInformationBooleanfalseEnable additional diagnostic information.
restrictPortsBooleanfalseRestrict WebRTC to the configured inclusive port range.
webrtcMinPortInt10000First WebRTC port when port restriction is enabled.
webrtcMaxPortInt10010Last WebRTC port when port restriction is enabled.
advertisePublicAddressBooleanfalseAdvertise the manually configured public address.
publicAddressString""Public address to offer when manual advertisement is enabled.
knowledgeBaseOrganizationString""Organization slug for public Bukkit/Paper player guides. Enables /enderdash guide [search]. Empty disables lookup.

autoUpdate defaults to true in the shared configuration. With autoUpdate: false, the agent checks for a new version at startup and writes it to the log, but downloads nothing. A manual enderdash update or an update started from the dashboard still downloads the new version. Container installations disable automatic binary downloads by default and update through image replacement.

Use real YAML booleans and integers. Keep the port range ordered and within valid network ports. Unknown configuration fields are preserved when the agent saves the file.

Default file

agentKey is empty until you register the agent. Replace it with the private key from this record's Setup page.

agentKey: ""
signalingUrl: "wss://signaling.enderdash.com/ws"
autoUpdate: true
debugConnectionLogs: false
debugInformation: false
restrictPorts: false
webrtcMinPort: 10000
webrtcMaxPort: 10010
advertisePublicAddress: false
publicAddress: ""
knowledgeBaseOrganization: ""

Runtime overrides

Only the key and signaling URL have these shared startup overrides:

SettingJVM system propertyEnvironment variable
Agent keyenderdash.agentKeyENDERDASH_AGENT_KEY
Signaling URLenderdash.signalingUrlENDERDASH_SIGNALING_URL

Precedence is a nonempty JVM property, then a nonempty environment variable, then the file value. Values are trimmed. JVM properties apply to JVM agents; environment variables apply to all targets.

Put properties before -jar:

java -Denderdash.agentKey='<agentKey>' -jar server.jar

A service or container can keep overriding a corrected file. Check the startup environment when the file value appears to be ignored. Restart the process after changing environment variables or JVM properties.

Apply a file change

On command-capable runtimes, use enderdash reload after changing the file. This reloads configuration and reconnects the agent. Standalone installations need a process restart.

Use enderdash install <agentKey> to register a new key through a plugin console. After any change, verify Online and a live panel. For fixed ports and public addresses, follow network requirements.

Protect diagnostic output

Enable connection debugging only for a focused investigation. Review logs before sharing them and remove keys, tokens, private endpoints, and player data.

Next: agent commands or agent maintenance.

Was this page helpful?

Send a quick note if anything is missing or unclear.

Last updated on