Skip to content

Commit 21dbfb9

Browse files
committed
docs(auth): scrub remaining SSH handshake secret references
Sweeps the trailing mentions left after the rebase: the gateway config-file module doc, the Helm gateway-config ConfigMap header, the gateway-config.mdx env-only note, and the RPM systemd unit comment for init-gateway-env.sh.
1 parent 8225f0f commit 21dbfb9

4 files changed

Lines changed: 5 additions & 7 deletions

File tree

crates/openshell-server/src/config_file.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//!
66
//! See `rfc/0003-gateway-configuration/README.md` for the file format. This
77
//! module parses the file into [`ConfigFile`], rejects fields that must be
8-
//! supplied via env/CLI (database URL, SSH handshake secret), and provides
8+
//! supplied via env/CLI (database URL), and provides
99
//! [`driver_table`] which overlays shared `[openshell.gateway]` defaults onto
1010
//! a `[openshell.drivers.<name>]` table so each driver crate's
1111
//! `Deserialize` impl sees a fully-populated table.

deploy/helm/openshell/templates/gateway-config.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ The gateway reads `/etc/openshell/gateway.toml` (mounted from this ConfigMap)
55
at startup. CLI flags and OPENSHELL_* env vars on the StatefulSet container
66
still override anything in this file.
77

8-
Two values are intentionally NOT rendered here:
8+
One value is intentionally NOT rendered here:
99
- server.dbUrl → passed via --db-url in the StatefulSet args
10-
- sshHandshake secret → injected as OPENSHELL_SSH_HANDSHAKE_SECRET env var
11-
from a Kubernetes Secret reference.
1210
*/}}
1311
apiVersion: v1
1412
kind: ConfigMap

docs/reference/gateway-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The OpenShell gateway reads its configuration from a TOML file when `--config` o
1616
CLI flag > OPENSHELL_* env var > TOML file > built-in default
1717
```
1818

19-
`database_url` and `ssh_handshake_secret` are env-only. The loader rejects them when they appear in the file.
19+
`database_url` is env-only. The loader rejects it when it appears in the file.
2020

2121
## Layout
2222

openshell.spec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ Type=exec
153153
# %%S expands to $XDG_STATE_HOME (~/.local/state) in user units.
154154
ExecStartPre=%{_libexecdir}/openshell/init-pki.sh %%S/openshell/tls
155155

156-
# Auto-generate gateway.env (SSH handshake secret + commented config
157-
# reference) on first start if not present.
156+
# Auto-generate gateway.env (commented config reference) on first
157+
# start if not present.
158158
# %%E expands to $XDG_CONFIG_HOME (~/.config) in user units.
159159
ExecStartPre=%{_libexecdir}/openshell/init-gateway-env.sh %%E/openshell/gateway.env
160160
EnvironmentFile=-%%E/openshell/gateway.env

0 commit comments

Comments
 (0)