Skip to content

Commit 99c6ba7

Browse files
committed
add Snap installation section to docs/about/installation.mdx
Document snap store installs with auto-connected plugs vs locally built snaps requiring manual connections. Cover refresh-mode: endure behavior and gateway service management. Fix NVIDIA#1611 Signed-off-by: Zygmunt Krynicki <[email protected]>
1 parent e59e9e0 commit 99c6ba7

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

‎docs/about/installation.mdx‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,65 @@ To keep the user service running after logout, enable linger:
7575
sudo loginctl enable-linger $USER
7676
```
7777

78+
## Snap
79+
80+
Install the OpenShell snap from the Snap Store:
81+
82+
```shell
83+
sudo snap install openshell --classic
84+
```
85+
86+
The snap defines two apps: the `openshell` CLI and the `openshell.gateway`
87+
systemd-style service. The gateway listens on `https://127.0.0.1:17670` and
88+
stores its database at `$SNAP_COMMON/gateway.db` (typically
89+
`/var/snap/openshell/common/gateway.db`). Create `$SNAP_COMMON/gateway.toml`
90+
when you need to override gateway settings.
91+
92+
### Snap store installs
93+
94+
When installing from the Snap Store, snapd automatically connects the `home`,
95+
`network`, `network-bind`, and `ssh-keys` plugs. The `docker` plug still
96+
requires manual connection:
97+
98+
```shell
99+
sudo snap connect openshell:docker docker:docker-daemon
100+
```
101+
102+
The snap declares `default-provider: docker` on the Docker plug so snapd will
103+
offer to install the Docker snap, but the connection itself must be made
104+
manually.
105+
106+
### Locally built snap packages
107+
108+
When installing a locally built `.snap` file, no plugs are connected by default:
109+
110+
```shell
111+
sudo snap install ./openshell_*.snap --dangerous --classic
112+
sudo snap connect openshell:home
113+
sudo snap connect openshell:network
114+
sudo snap connect openshell:network-bind
115+
sudo snap connect openshell:ssh-keys
116+
sudo snap connect openshell:docker docker:docker-daemon
117+
sudo snap connect openshell:log-observe
118+
sudo snap connect openshell:system-observe
119+
```
120+
121+
The `log-observe` and `system-observe` plugs are needed for the gateway service
122+
to read logs and inspect system processes. The `docker` plug requires the
123+
`docker:docker-daemon` slot from the Docker snap and does not work with
124+
system-installed Docker.
125+
126+
### Gateway service
127+
128+
The gateway runs as a snap daemon with `refresh-mode: endure`, meaning snapd
129+
will not restart it during snap refreshes. This prevents the gateway from
130+
killing active sandbox sessions mid-refresh. Restart the service manually after
131+
a snap refresh when you need the updated binary:
132+
133+
```shell
134+
sudo systemctl restart snap.openshell.gateway
135+
```
136+
78137
## Kubernetes
79138

80139
Kubernetes deployments use the OpenShell Helm chart. For step-by-step installation, refer to [Kubernetes Setup](/kubernetes/setup). For chart values and packaging details, refer to the [Helm chart README](https://github.com/NVIDIA/OpenShell/blob/main/deploy/helm/openshell/README.md).

0 commit comments

Comments
 (0)