Agent configuration
Configuration locations, current defaults, runtime overrides, and reload behavior.
Configuration locations
| Runtime | Default location |
|---|---|
| Bukkit-family and BungeeCord | plugins/EnderDash/config.yml |
| Velocity | plugins/enderdash/config.yml |
| Hytale | EnderDash's runtime-owned plugin data directory |
| Standalone Linux and macOS | ~/.enderdash/config.yml |
| Standalone Windows | %APPDATA%\EnderDash\config.yml |
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 generated from the shared agent configuration in this checkout. They are file defaults; a runtime launcher can override them.
| Option | Type | Default | Purpose |
|---|---|---|---|
agentKey | String | "" | Secret key for one server record. Required for registration. |
signalingUrl | String | "wss://signaling.enderdash.com/ws" | Signaling WebSocket endpoint. Keep the default for the hosted service. |
autoUpdate | Boolean | true | Stage available agent updates. A restart applies a staged artifact. |
debugConnectionLogs | Boolean | false | Enable connection lifecycle logs for diagnosis. |
debugInformation | Boolean | false | Enable additional diagnostic information. |
restrictPorts | Boolean | false | Restrict WebRTC to the configured inclusive port range. |
webrtcMinPort | Int | 10000 | First WebRTC port when port restriction is enabled. |
webrtcMaxPort | Int | 10010 | Last WebRTC port when port restriction is enabled. |
advertisePublicAddress | Boolean | false | Advertise the manually configured public address. |
publicAddress | String | "" | Public address to offer when manual advertisement is enabled. |
autoUpdate defaults to true in the shared configuration. 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: ""Runtime overrides
Only the key and signaling URL have these shared startup overrides:
| Setting | JVM system property | Environment variable |
|---|---|---|
| Agent key | enderdash.agentKey | ENDERDASH_AGENT_KEY |
| Signaling URL | enderdash.signalingUrl | ENDERDASH_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.jarA 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