Skip to content

fix(snap): use snap-owned XDG directories #1972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pimlock merged 3 commits into from
Jun 25, 2026
+15 −2
Merged

fix(snap): use snap-owned XDG directories #1972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da3efe9
fix(snap): use snap-owned XDG directories
pimlock Jun 22, 2026
b19077a
remove unneeded test
pimlock Jun 23, 2026
4c3bf1a
docs(snap): document snap-owned CLI state
pimlock Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/about/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ sudo loginctl enable-linger $USER
Install the OpenShell snap from the Snap Store:

```shell
sudo snap install openshell --classic
sudo snap install openshell
```

The snap defines two apps: the `openshell` CLI and the `openshell.gateway`
Expand All @@ -89,6 +89,11 @@ stores its database at `$SNAP_COMMON/gateway.db` (typically
`/var/snap/openshell/common/gateway.db`). Create `$SNAP_COMMON/gateway.toml`
when you need to override gateway settings.

The snap CLI stores per-user config, data, and state under `$SNAP_USER_COMMON`,
typically `~/snap/openshell/common`. Gateway registrations live under
`$SNAP_USER_COMMON/.config/openshell/gateways/` instead of
`~/.config/openshell/gateways/`.

### Snap store installs

When installing from the Snap Store, snapd automatically connects the `home`,
Expand All @@ -108,7 +113,7 @@ manually.
When installing a locally built `.snap` file, no plugs are connected by default:

```shell
sudo snap install ./openshell_*.snap --dangerous --classic
sudo snap install ./openshell_*.snap --dangerous
sudo snap connect openshell:home
sudo snap connect openshell:network
sudo snap connect openshell:network-bind
Expand Down
8 changes: 8 additions & 0 deletions snapcraft.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ platforms:
apps:
openshell:
command: bin/openshell
environment:
XDG_CONFIG_HOME: "$SNAP_USER_COMMON/.config"
XDG_DATA_HOME: "$SNAP_USER_COMMON/.local/share"
XDG_STATE_HOME: "$SNAP_USER_COMMON/.local/state"
plugs:
- home
- network
Expand All @@ -70,6 +74,10 @@ apps:
term:
command: bin/openshell term
desktop: meta/gui/term.desktop
environment:
XDG_CONFIG_HOME: "$SNAP_USER_COMMON/.config"
XDG_DATA_HOME: "$SNAP_USER_COMMON/.local/share"
XDG_STATE_HOME: "$SNAP_USER_COMMON/.local/state"
plugs:
- home
- network
Expand Down
Loading