Skip to content

About

Pangolin network connectivity for Omarchy: VPN connection status, proxy resources and web-app shortcuts. Cloud and self-hosted.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Pangolin for Omarchy — an original watercolor pangolin beside a laptop

Pangolin for Omarchy

Your connections, close at hand. A community bar plugin for Pangolin network connectivity, VPN connection status, proxy resources and web-app shortcuts — painted in your active Omarchy theme.

Latest regular release License: MIT Hosting: Cloud and self-hosted Style: Omarchy theme

Install · User guide · Configure · Latest release · Deutsch

The real plugin UI in two demonstration themes; all resources are fictional

What Pangolin does

Pangolin provides controlled access to resources on remote networks. Public web resources can be reached through a browser; private resources use a Pangolin client connection. Administrators define the resources and who may access them. The Omarchy plugin adds connection controls and shortcuts to the resources your account can use. Pangolin's explanation.

Pangolin for Omarchy: account access, apps and web resources, and theme integration

How access works and how to get started

Conceptual web and private access paths, followed by the three setup steps

These are illustrated guides. The screenshot above renders the actual plugin with synthetic data. Follow the requirements and setup guide for installation details.

A small panel for everyday access

Connection Resources Your desktop
Connect, disconnect and inspect local tunnel status. Open public services and compact private-resource tiles. Install resources as web apps, or open existing matching apps.
Green means connected; orange needs attention; red means disconnected or an error. Copy a web URL or host address with one click. Text, washes, accents and status colors follow Omarchy.

The SVG symbol breathes and soft color washes drift only while the panel is open and a fresh connection is confirmed. Closing the panel, disconnecting or losing status stops connection motion. A short resource-icon hover transition adds feedback without a repeating animation. Quiet, readable controls remain available throughout.

Community release · English interface. Independent of Pangolin and Omarchy. All screenshots and examples use synthetic resources. The desktop interface uses your theme's colors. Artwork and rendering.

Requirements

Omarchy Quattro with the Quickshell plugin API (Color.popups, Ui.Panel, KeyboardPanel), Python 3.10+, and the Pangolin CLI with a readable local OLM socket. Resource discovery requires the launcher API and an existing CLI account. The plugin installer does not install the Pangolin CLI or other system dependencies; see the complete requirements.

Runtime commands: python3, timeout, pangolin, omarchy, chromium, gtk-launch, wl-copy, xdg-open, and optionally notify-send. The plugin uses Python's standard library; no pip packages are required. See compatibility for the test scope.

Install

omarchy plugin add https://github.com/PatrickIsenegger/omarchy-pangolin.git --enable

This installs and enables the plugin checkout only. Install the official Pangolin CLI, then run pangolin login and pangolin up separately. Use the requirements and read-only checks to verify the local commands and OLM socket.

For a local source checkout:

omarchy plugin add /path/to/omarchy-pangolin --enable

Pangolin Cloud and self-hosted servers

Both are supported through the active CLI account. For Pangolin Cloud:

pangolin login

For a self-hosted server:

pangolin login

Choose the Cloud or self-hosted server in the CLI login flow.

Select your organization using the CLI. When using several accounts, select the required organization with the CLI (for example, pangolin select org --org <org-id>) and reopen the panel to refresh resources. The plugin uses the session API on the selected dashboard host, not the separate integration API at api.pangolin.net. You do not need a new integration API key.

Cloud and self-hosted account/request handling are covered by synthetic tests. Authenticated Cloud end-to-end testing still needs a Cloud account.

Official client endpoint documentation.

The plugin uses that active account. Connect from the panel; any privilege prompt is handled by Pangolin in a terminal. Nothing connects automatically on installation.

The plugin ID is community.pangolin. Updating an older patrick.pangolin installation? Follow the one-time migration to preserve its position and settings. Omarchy will not overwrite an existing installation with that ID. Back up an existing custom copy and its configuration before migrating; do not delete it blindly.

Use

Open or close the enabled plugin panel from a terminal:

omarchy-shell shell toggle community.pangolin

The same command can be assigned to a keyboard shortcut. It opens the panel only; it does not connect or disconnect Pangolin. Omarchy's shell must be running and the plugin enabled.

Resources use a compact single-line layout: a checked window identifies an installed app, a globe a browser link, and overlapping sheets an address-only resource. App tiles have a subtle flat tint; there are no repeated type labels or resource watercolor fills. Hover or focus a resource for its full name, target and requirements.

Left-click a resource to open it (or copy an address-only host). The ⋮ menu, also available by right-click, contains opening, copying and app installation. ? Help in the panel opens the user guide. Left-click the bar icon to toggle the panel; right-click the bar icon opens the account dashboard.

The icon and header follow the theme accent. Connection dots show green for confirmed connections, orange for pending/unknown states and warnings, and red for disconnected/error states. Semantic colors use the theme palette or matching saturation and lightness when a theme lacks suitable colors.

Private resources need an active Pangolin connection and working alias DNS. A host resource is not necessarily a web service: configure a full URL or a known scheme under settings. A TCP allowlist alone does not identify HTTP versus HTTPS.

Restart shell restarts the entire Omarchy shell, including its bar and other plugins. It does not disconnect the VPN.

Settings

The gear button opens $XDG_CONFIG_HOME/omarchy-pangolin/config.json (default ~/.config/omarchy-pangolin/config.json). Settings live outside the plugin checkout and survive updates. Overrides are scoped by server and organization. Configuration reference.

Demo mode uses only generated data and disables actions. Enable the widget's demo setting for previews. It never loads account credentials or requests a server.

Update and remove

omarchy plugin update community.pangolin
omarchy plugin remove community.pangolin

The Omarchy updater follows the repository's default branch, not the newest GitHub Release. main is reserved for reviewed release commits. See releases and rollback.

Removal leaves your separately stored settings and installed web apps intact. Remove unwanted apps with omarchy webapp remove.

Privacy and permissions

The plugin runs with your desktop user's permissions. It reads the active CLI account file and uses its session token for HTTPS API calls to that account's server. Tokens are not copied into plugin configuration or printed. Authenticated redirects are rejected. There is no telemetry or external icon download.

Public resources and private resources come from the authorized launcher list. Optional administrative metadata enriches private ports; denied metadata access does not replace or broaden the launcher list. Application probes are not run automatically. Desktop app installation is explicit, with a shared installation lock and filename collision handling.

Do not attach credentials, raw account files, private URLs, or unredacted logs to issues. Use synthetic examples. Troubleshooting.

Development

python3 -m unittest discover -s tests -v
omarchy plugin validate .

See contributing, changelog, license and third-party notices.


Built by Patrick Isenegger. Ideas and reproducible issues are welcome — please use fictional resources when sharing examples.

About

Pangolin network connectivity for Omarchy: VPN connection status, proxy resources and web-app shortcuts. Cloud and self-hosted.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages