From 6e5bbf6e8e478362779336484a2ad328d6bb5b98 Mon Sep 17 00:00:00 2001 From: Russell Bryant Date: Fri, 8 May 2026 15:22:32 -0400 Subject: [PATCH] docs: document OPENSHELL_SSH_HANDSHAKE_SECRET in Getting Started The Podman and Kubernetes compute drivers require OPENSHELL_SSH_HANDSHAKE_SECRET to be set. This was introduced in 2e0afeab ("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 --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c091c6c4..aa3d1b0a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,6 +152,10 @@ cargo build -p openshell-prover --features bundled-z3 # One-time trust mise trust +# Podman and Kubernetes drivers require an SSH handshake secret. +# Set any value for local development: +export OPENSHELL_SSH_HANDSHAKE_SECRET=dev-secret + # Run a standalone gateway for local development mise run gateway ```