Deployment Environment Variables
These are the environment variables you are most likely to care about when moving a robot between local development and deployment.
Usually required in deployed environments
GOPHER_ENCRYPTION_KEY- Unlocks encrypted config values and encrypted robot keys.
GOPHER_CUSTOM_REPOSITORY- The git URL for the robot repository when bootstrapping from an empty directory.
GOPHER_DEPLOY_KEY- A deploy key the robot can use to clone
GOPHER_CUSTOM_REPOSITORY.
- A deploy key the robot can use to clone
Commonly useful
GOPHER_ENVIRONMENT- Selects
custom/conf/environments/<environment>.yaml. - Defaults to
developmentfor scaffolded robots when not set.
- Selects
GOPHER_CUSTOM_BRANCH- Overrides the branch used for custom config checkout and update flows.
GOPHER_SSH_PORT- Overrides the SSH connector listen port.
GOPHER_LOGDEST- Overrides the log destination, for example
stdoutorrobot.log.
- Overrides the log destination, for example
GOPHER_LOGLEVEL- Sets the runtime log level.
GOPHER_MESSAGE_FORMAT- Overrides the default outgoing format. If unset, v3 defaults to
BasicMarkdown.
- Overrides the default outgoing format. If unset, v3 defaults to
Variables that matter mostly during local development
GOPHER_ENVIRONMENT=development- Explicitly pins the development environment if you maintain several.
GOPHER_SSH_PORT- Helpful when you run more than one local robot.
GOPHER_DEFAULT_PROTOCOL- Useful only for special multi-protocol routing cases.
Practical advice
- Keep
.envmode-restricted and out of casual reach. - Prefer putting deployment-specific values in
.envand stable robot behavior incustom/conf/. - Do not depend on old top-level
GOPHER_PROTOCOLhabits as your main environment selector; v3 expectsGOPHER_ENVIRONMENTto drive environment-specific config.