Repository navigation
Releases
0.4.0
Upgrade required
After updating, open the VPN panel and run Update setup, or run make install from your checkout. Updating the plugin clone alone does not replace installed root helpers and trusted modules.
Existing profiles, keys, subscriptions, favourites and recent connections are retained. Old protection-cache records become unverified until refreshed or retested.
Highlights
- INCY Desktop subscriptions alongside Happ: server groups, refresh, headless connect/disconnect and xray-based ping. Validated with INCY Desktop 3.9.0 and bundled Ferrum 26.10.13; the app and plugin cannot own a tunnel simultaneously.
- Profile management improvements: delete VLESS/Shadowsocks keys, manage OpenVPN autostart and disconnect orphan WireGuard/AmneziaWG interfaces.
- Copy exit IP from the connection summary and faster cache-only status polling.
Security and reliability
- Endpoint bootstrap uses authenticated, uplink-bound DNS sockets restricted to configured IPv4 upstreams. Ordinary application and shared systemd-resolved DNS receive no kill-switch exception.
- WireGuard, AmneziaWG and OpenVPN share one endpoint snapshot between firewall rules and private numeric runtime profiles. No public DNS fallback or automatic DNS-settings rewrite is introduced; unsupported strict DoT/local-proxy configurations fail explicitly.
- INCY native code runs as the desktop user; fixed root-owned brokers provide narrowly validated network operations.
- WG/AWG SaveConfig preserves original hostnames, IPv6 interface addresses and peer AllowedIPs while retaining native changes. Recovery refuses to overwrite replacement credentials and retains private recovery data on conflict.
- Protection checks and Happ/INCY actions distinguish subscriptions even when server names match.
- Bootstrap permissions follow resolver changes during switching; failed setup remains fail-closed.
- OpenVPN detects standard systemd units without helper PID files. Managed autostart units use the fixed PID/DNS lifecycle and optional IPv6 boot guard.
- DNS probe cancellation no longer waits for stuck libc lookups. Uninstall cleans managed boot/service drop-ins before deleting its helper and aborts if cleanup fails.
Compatibility notes
- OpenVPN option names must be plain: quoted or escaped option names are rejected; quoted hostname arguments remain supported.
- Tunnels remain IPv4-only. The optional IPv6 guard disables IPv6 rather than tunnelling it.
- NetworkManager VPNs remain outside the plugin-managed kill switch.
- INCY configurations containing Shadowsocks temporarily disable TUN sniffing to avoid a reproduced external-TUN-FD HTTP/TLS stall. Domain rules requiring sniffed names may not match; IP-based rules and kill-switch separation are unchanged. VLESS-only configurations retain sniffing.
Full changes: CHANGELOG.md.
0.3.2
Root helpers are installed from a copy read before sudo; the sudoers rule names the numeric uid. Run Update setup after updating. Full notes in CHANGELOG.md.
0.3.1
Fixes the marketplace listing text and "1 server". Full notes in CHANGELOG.md.
v0.3.0
Release 0.3.0: marketplace install, a much narrower root surface, and fixes for hanging connects. Full notes in CHANGELOG.md.
Important
Privileged code changed (CONTRIBUTING: plugins.omarchy.org needs a new maintainer review):
install.sh (and the sudoers rule it writes), uninstall.sh, and the new
scripts/omarchy-vpn-helper. The sub-intercept-* / happd-sniff* / happd-extract-config.py
scripts are removed. happ-killswitch is unchanged since v0.2.0.
Highlights
- Marketplace install:
omarchy plugin adddownloads the plugin, and the panel's Finish setup / Update setup runsinstall.shin a terminal. An install wizard asks for protocols and features before any password and installs only the packages they need. - Security:
- The sudoers rule is cut down to three fixed entry points. Before, it let any user process get passwordless root (
wg-quick *,cp/catwildcards,kill). - The root helper refuses imports that could run commands as root. For WireGuard that means
PostUpand its kin. For OpenVPN, a config is imported only if every directive is on an allowlist. WireGuard profile names longer than 15 characters are refused too. - IPv6 no longer leaks at boot or while switching servers.
- The subscription header capture, which used a local CA, is removed.
- The sudoers rule is cut down to three fixed entry points. Before, it let any user process get passwordless root (
- Fixed:
- Happ connects no longer hang on a stale subscription.
- Quick clicks while switching no longer answer "Already switching".
- A connect is refused while the Happ app holds the tunnel.
- A failed setup step says "Setup failed" instead of "Done!".
- Background subscription failures are logged.
- README is rewritten for users, with badges. Real provider names and identifiers are removed from code and tests.
Upgrading
After omarchy plugin update omarchy-vpn, press Update setup in the panel (or run make install from a checkout). The sudoers rule, helpers and backend are copies and only change then.
Tested
make test-docker: 839 passed; ruff, mypy, shellcheck (--severity=warning) clean; SonarCloud quality gate passed with 0 open issues.- Fresh Omarchy 4.0.6 VM, on
dev:omarchy plugin validateandplugin add;- Finish setup through the wizard and sudo;
- the panel, the window and SUPER+Shift+V;
plugin update, then Update setup;uninstall.shandplugin remove.
- After setup, the sudoers rule allowed only the three entry points. After uninstall, nothing was left behind except
~/.config/vpn-manager.
[0.2.0]
What's Changed
- Bump SonarSource/sonarqube-scan-action from 8.2.2 to 8.3.0 by @dependabot[bot] in #1
- Feat/happ default headers by @moonmouse11 in #2
- feat: fix happ headers in menu by @moonmouse11 in #3
- feat: make preview & status bar templates by @moonmouse11 in #4
- feat: happ widget update & connection priority by @moonmouse11 in #5
- feat: strict kill switch — DNS only through the tunnel, Lockdown by @moonmouse11 in #6
- fix: hostname servers under the kill switch; on-demand ping through … by @moonmouse11 in #7
- Fix/killswitch forward by @moonmouse11 in #8
- feat: app window replaces the omarchy.menu menu by @moonmouse11 in #9
- feat: profiles in the app window — import and autostart/delete by @moonmouse11 in #10
- Feat/app window checks by @moonmouse11 in #11
- Feat/quick connect by @moonmouse11 in #12
- chore: release 0.2.0 by @moonmouse11 in #13
New Contributors
- @dependabot[bot] made their first contribution in #1
- @moonmouse11 made their first contribution in #2
Full Changelog: https://github.com/moonmouse11/omarchy-vpn/commits/v0.2.0