Skip to content

Commit af60d4e

Browse files
authored
docs: document OPENSHELL_SSH_HANDSHAKE_SECRET in Getting Started (#1287)
The Podman and Kubernetes compute drivers require OPENSHELL_SSH_HANDSHAKE_SECRET to be set. This was introduced in 2e0afea ("feat(vm): derive guest rootfs from sandbox images (#957)"), which exempted only the Docker and VM drivers from the check. The Getting Started instructions in CONTRIBUTING.md didn't mention the variable, so developers using Podman (the default on systems where it is installed) hit an opaque configuration error on first run. Add the export as a separate setup step with a comment explaining which drivers require it. Signed-off-by: Russell Bryant <russell.bryant@gmail.com>
1 parent 1c79b21 commit af60d4e

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,10 @@ cargo build -p openshell-prover --features bundled-z3
152152
# One-time trust
153153
mise trust
154154

155+
# Podman and Kubernetes drivers require an SSH handshake secret.
156+
# Set any value for local development:
157+
export OPENSHELL_SSH_HANDSHAKE_SECRET=dev-secret
158+
155159
# Run a standalone gateway for local development
156160
mise run gateway
157161
```

0 commit comments

Comments
 (0)