Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Troubleshooting

When config behaves strangely, start with the engine’s own view of the world.

Best tools

  • gopherbot validate <path>
  • gopherbot dump installed robot.yaml
  • gopherbot dump configured robot.yaml
  • gopherbot dump configured protocols/ssh.yaml

Common causes of trouble

  • a value moved from robot.yaml into a provider or protocol file in v3
  • an old top-level UserMap still exists somewhere
  • ProtocolConfig is missing for the active primary protocol
  • duplicate YAML mapping keys, including repeated usernames in UserMap
  • a list was overridden when you meant to append, or appended when you meant to replace
  • .env is missing required deployment values for bootstrap mode

Operational advice

If a secondary connector fails to initialize, inspect protocol-list and the startup log for its configuration error. YAML errors include the duplicate key and line numbers; template errors identify the failing expansion. Correct the reported file before reloading configuration and retrying the connector. The primary connector stays available when a secondary’s configuration fails. Each connector receives only its own configuration; a missing or invalid protocol file never falls back to another connector’s settings. Existing files with read or template errors also cannot silently fall back to installed defaults.

If reload fails, treat that as a config problem first, not a plugin bug. The merge and validation tools will usually point you to the real issue faster than trial-and-error editing.