You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a2a00e1
Browse filesBrowse the repository at this point in the historyBrowse files
docs(installation): document snap install path and reword native to classic
Add full Snap installation documentation including interface connections,
gateway verification, and when to choose Snap vs classic packages.
Reword references from 'native package' to 'classic' throughout.
Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
Copy file name to clipboardExpand all lines: docs/about/installation.mdx
+58-1Lines changed: 58 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Install OpenShell with a single command:
16
16
curl -LsSf https://raw.githubusercontent.com/NVIDIA/OpenShell/main/install.sh | sh
17
17
```
18
18
19
-
The script detects your operating system and installs the OpenShell CLI and gateway with your native package manager. It then starts the local gateway server so you can begin creating sandboxes.
19
+
The script detects your operating system and installs the OpenShell CLI and gateway. On Linux, the Snap path is preferred when `snapd` is available; otherwise the script uses the native DEB or RPM package. The gateway then starts automatically so you can begin creating sandboxes.
20
20
21
21
You can also download release artifacts directly from the [OpenShell GitHub Releases](https://github.com/NVIDIA/OpenShell/releases) page.
22
22
@@ -51,6 +51,8 @@ brew services restart openshell
51
51
52
52
## Linux
53
53
54
+
On distributions that ship with `snapd`, the install script uses the Snap path described below. On hosts without `snapd` (or with `OPENSHELL_INSTALL_METHOD=classic` set), the script falls back to the classic package manager.
55
+
54
56
On Fedora and RHEL, the install script uses RPM packages. The RPM installs the `openshell` CLI, the `openshell-gateway` daemon, and a systemd user service.
55
57
56
58
On Debian and Ubuntu, the install script uses a Debian package. The Debian package installs the `openshell` CLI, the `openshell-gateway` daemon, VM sandbox support, and a systemd user service.
@@ -75,6 +77,61 @@ To keep the user service running after logout, enable linger:
75
77
sudo loginctl enable-linger $USER
76
78
```
77
79
80
+
## Snap
81
+
82
+
On Linux distributions that ship with `snapd`, the install script installs OpenShell from the Snap Store. The OpenShell snap bundles the CLI, the terminal UI, and a managed gateway daemon. snapd handles upgrades and rollback; the gateway runs as a system service inside the snap.
83
+
84
+
You can also install the snap directly:
85
+
86
+
```shell
87
+
sudo snap install openshell
88
+
```
89
+
90
+
The snap requires the Docker snap. `default-provider: docker` on the OpenShell snap installs the Docker snap automatically on first use, but you can install it up front with:
91
+
92
+
```shell
93
+
sudo snap install docker
94
+
```
95
+
96
+
### Connect the required interfaces
97
+
98
+
Strict confinement requires explicit `snap connect` for several interfaces. The installer runs these for you on Snap installs; run them by hand if you install the snap manually:
The Docker slot is the Docker snap's `docker-daemon` slot; OpenShell does not work with a host-installed Docker Engine. The installer is best-effort: if a connect fails (for example because the Docker snap is not yet running), the snap still installs and the installer prints a warning.
108
+
109
+
### Verify the gateway
110
+
111
+
The snap-managed gateway service is `openshell.gateway`. Inspect it with:
The gateway listens on `https://127.0.0.1:17670` and stores its state under `/var/snap/openshell/common/`. Override gateway settings by creating `/var/snap/openshell/common/gateway.toml`.
126
+
127
+
### When to choose Snap
128
+
129
+
Use Snap when `snapd` is available and you want atomic upgrades and rollback, a single self-contained install that bundles the Docker provider, or a desktop launcher that surfaces the OpenShell terminal UI in the application menu.
130
+
131
+
Use DEB or RPM when `snapd` is unavailable or inappropriate (immutable distros, headless servers, locked-down images), when you need direct `systemd --user` integration for the gateway, or when you already run Docker Engine from a non-snap source.
132
+
133
+
Set `OPENSHELL_INSTALL_METHOD=classic` to force the classic package on hosts that also have `snapd` available.
134
+
78
135
## Kubernetes
79
136
80
137
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