diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index 6f1b6a51b..ccaf4e1ee 100644 --- a/learn/getting-started/install-and-connect-harper.mdx +++ b/learn/getting-started/install-and-connect-harper.mdx @@ -110,6 +110,10 @@ The image is configured to automatically run the `harper` command upon startup. The Harper installation process is normally an interactive prompt; however, it also supports overrides using environment variables or CLI arguments. Since the image contains preset environment variables and additional environment variables `DEFAULTS_MODE` and `REPLICATION_HOSTNAME` are included in the `docker run` command, Harper will complete its installation step completely non-interactively. +:::tip +This is not limited to installation: any option in Harper's own `harper-config.yaml` can be set with an environment variable by mapping its YAML key to `SCREAMING_SNAKE_CASE` (`http.port` becomes `HTTP_PORT`, `replication.hostname` becomes `REPLICATION_HOSTNAME`), which makes using `-e` flags the natural way to configure a containerized instance. This applies to instance configuration only — component configuration, the settings in a component's own `config.yaml`, cannot be set via environment variables or CLI arguments. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention. +::: +