From b79e1152ed35b1e223844e281b7c6846c38fd463 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Thu, 27 Aug 2026 14:33:53 -0600 Subject: [PATCH 1/3] docs(learn): link Docker install tab to env var configuration reference The Docker tab in the install guide mentioned DEFAULTS_MODE, REPLICATION_HOSTNAME, and "preset environment variables" without ever pointing at the canonical reference, so readers never learned that any Harper configuration option can be set through an environment variable. Add a short tip inside the Docker tab that states the general rule, gives the SCREAMING_SNAKE_CASE mapping in one line, and links to the Environment Variables section of the configuration reference. Co-Authored-By: Claude Opus 5 --- learn/getting-started/install-and-connect-harper.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index 6f1b6a51b..c6f37ce66 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_ Harper configuration option 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 `-e` flags the natural way to configure a containerized instance. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention. +::: + From 8e8bc6d7aedc862570f6cf8bf37d0ddef248e2b4 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Thu, 27 Aug 2026 15:39:42 -0600 Subject: [PATCH 2/3] docs(learn): fix subject-verb agreement in Docker env var tip Review feedback on #643: "makes `-e` flags the natural way" mismatched plural subject with singular complement. Gerund "using" fixes it. Co-Authored-By: Claude Opus 5 --- learn/getting-started/install-and-connect-harper.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index c6f37ce66..733390cd7 100644 --- a/learn/getting-started/install-and-connect-harper.mdx +++ b/learn/getting-started/install-and-connect-harper.mdx @@ -111,7 +111,7 @@ 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_ Harper configuration option 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 `-e` flags the natural way to configure a containerized instance. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention. +This is not limited to installation: _any_ Harper configuration option 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. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention. ::: From 9eb9be6ef81e26a01069d72d5a38b7d686ba7f58 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Fri, 28 Aug 2026 13:04:18 -0600 Subject: [PATCH 3/3] docs(learn): scope Docker env var tip to instance configuration The tip claimed *any* Harper configuration option can be set with an environment variable, which a Docker user could reasonably apply to a component's config.yaml, where it silently does nothing. Scope the claim to harper-config.yaml and state the component-configuration exception using the same wording as reference/configuration/overview.md. Co-Authored-By: Claude Opus 5 --- learn/getting-started/install-and-connect-harper.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learn/getting-started/install-and-connect-harper.mdx b/learn/getting-started/install-and-connect-harper.mdx index 733390cd7..ccaf4e1ee 100644 --- a/learn/getting-started/install-and-connect-harper.mdx +++ b/learn/getting-started/install-and-connect-harper.mdx @@ -111,7 +111,7 @@ 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_ Harper configuration option 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. See [Environment Variables](/reference/v5/configuration/overview#2-environment-variables) in the configuration reference for the full naming convention. +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. :::