From 8bc1238014b863b5055b25e12be7f2dd0fc5e315 Mon Sep 17 00:00:00 2001 From: Zygmunt Krynicki Date: Tue, 2 Jun 2026 20:43:25 +0200 Subject: [PATCH] feat(snap): expand snap description with setup instructions Add a description covering the snap elements, step-by-step setup for Docker and interface connections, gateway verification commands, and links to documentation and source code. Signed-off-by: Zygmunt Krynicki --- snapcraft.yaml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/snapcraft.yaml b/snapcraft.yaml index 25bd4d950..e1a69cd30 100644 --- a/snapcraft.yaml +++ b/snapcraft.yaml @@ -11,6 +11,38 @@ description: | policy-enforced egress routing, credential proxying, and privacy-aware LLM inference routing. + The OpenShell snap ships a CLI (`openshell`), a terminal UI + (`openshell.term`), and a managed gateway daemon (`openshell.gateway`). + + **Setup instructions** + + 1. Install the Docker snap: + + sudo snap install docker + + Support for system-installed Docker is coming in snapd 2.76. + + 2. Connect the required interfaces and start the gateway: + + sudo snap connect openshell:docker docker:docker-daemon + sudo snap connect openshell:log-observe + sudo snap connect openshell:system-observe + sudo snap connect openshell:ssh-keys + sudo snap start openshell.gateway + + 3. Verify the gateway and register it locally: + + snap services openshell.gateway + openshell status + openshell gateway add http://127.0.0.1:17670 --local --name openshell-gateway + + After a snap refresh, restart the gateway to pick up the new revision: + + sudo snap restart openshell.gateway + + Restarting the gateway will interrupt active sandbox sessions. The gateway + is not restarted automatically to avoid disconnecting running sandboxes. + base: core24 grade: stable confinement: strict