Skip to content

docs(learn): link Docker install tab to env var configuration reference #643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ethan-Arrowood wants to merge 3 commits into
base: main
Choose a base branch
from
+4 −0
Open

docs(learn): link Docker install tab to env var configuration reference #643

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b79e115
docs(learn): link Docker install tab to env var configuration reference
Ethan-Arrowood Aug 27, 2026
8e8bc6d
docs(learn): fix subject-verb agreement in Docker env var tip
Ethan-Arrowood Aug 27, 2026
9eb9be6
docs(learn): scope Docker env var tip to instance configuration
Ethan-Arrowood Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions learn/getting-started/install-and-connect-harper.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
Comment on lines +113 to +115

@gemini-code-assist gemini-code-assist Bot Aug 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase "makes -e flags the natural way" has a slight grammatical/plurality mismatch ("flags" is plural, "the natural way" is singular). Consider revising to "makes using -e flags the natural way" or "makes -e flags the natural choice" to improve readability.

:::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.
:::


</TabItem>
</Tabs>

Expand Down