Skip to content

Update Boundary worker config docs #1339

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

Merged
merged 3 commits into from
Nov 19, 2025
Merged

Update Boundary worker config docs #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf4a612
Update Boundary Worker docs with ssh_known_hosts_path
louisruch Nov 18, 2025
41d7f23
Update content/boundary/v0.21.x/content/docs/workers/index.mdx
louisruch Nov 19, 2025
67be540
Update content/boundary/v0.21.x/content/partials/configuration-refere…
louisruch Nov 19, 2025
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
2 changes: 1 addition & 1 deletion content/boundary/v0.21.x/content/docs/workers/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you are using pre-0.15 workers with pre-0.15 upstream configurations, please

## Signals

The `SIGHUP` signal causes a worker to reload its configuration file to pick up any updates for the `initial_upstreams` and `tags` values.
The `SIGHUP` signal causes a worker to reload its configuration file to pick up any updates for the `initial_upstreams`, `tags`, and `ssh_known_hosts_path` values.
Boundary ignores other updated values.

The `SIGTERM` and `SIGINT` signals initiate a graceful shutdown on a worker. The worker waits for any sessions to drain
Expand Down
4 changes: 4 additions & 0 deletions ...x/content/partials/configuration-reference/workers/common-worker-parameters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ worker {
`initial_upstreams`. This parameter is valid only for workers using the worker-led or controller-led
registration method and for workers directly connected to HCP Boundary.

- `ssh_known_hosts_path` - Specifies the path of the `known_hosts` file that the worker uses to verify an SSH target's SSH host key. The path must already exist. If you do not provide a path, the
worker skips host key verification. On `SIGHUP`, the `known_hosts` file is reparsed and the new values are used.
SSH targets and SSH credential injection are Enterprise-only features.

- `recording_storage_path` - A path to the local storage for recorded sessions.
Boundary stores session recordings in the local storage while they are in progress.
When the session is complete, Boundary moves the local session recording to remote storage and deletes the local copy.
Expand Down
Loading