A feature-complete Web UI for Headscale
Go to file
2025-04-02 17:18:35 -04:00
.github
.zed
agent
app chore: remove unused code in the user overview 2025-04-02 17:18:35 -04:00
assets
docs chore: update docs 2025-04-02 17:03:58 -04:00
nix chore: update nix hash 2025-04-02 13:40:50 -04:00
patches fix: serve css and js assets correctly 2025-04-02 14:27:23 -04:00
public
test
.dockerignore
.env.example
.envrc
.gitignore
.npmrc
agent.Dockerfile
biome.json
CHANGELOG.md chore: v0.5.7 2025-04-02 14:47:50 -04:00
compose.yaml
config.example.yaml fix: open file in a+ to avoid read issues 2025-04-02 13:40:01 -04:00
Dockerfile
flake.lock
flake.nix
go.mod
go.sum
lefthook.yml
LICENSE
package.json chore: v0.5.7 2025-04-02 14:47:50 -04:00
pnpm-lock.yaml fix: serve css and js assets correctly 2025-04-02 14:27:23 -04:00
react-router.config.ts
README.md
tailwind.config.ts
tsconfig.json
vite.config.ts chore: v0.5.7 2025-04-02 14:47:50 -04:00

Headplane

A feature-complete web UI for Headscale

Preview

Headscale is the de-facto self-hosted version of Tailscale, a popular Wireguard based VPN service. By default, it does not ship with a web UI, which is where Headplane comes in. Headplane is a feature-complete web UI for Headscale, allowing you to manage your nodes, networks, and ACLs with ease.

Headplane aims to replicate the functionality offered by the official Tailscale product and dashboard, being one of the most feature complete Headscale UIs available. These are some of the features that Headplane offers:

  • Machine management, including expiry, network routing, name, and owner management
  • Access Control List (ACL) and tagging configuration for ACL enforcement
  • Support for OpenID Connect (OIDC) as a login provider
  • The ability to edit DNS settings and automatically provision Headscale
  • Configurability for Headscale's settings

Deployment

Headplane runs as a server-based web-application, meaning you'll need a server to run it. It's available as a Docker image (recommended) or through a manual installation. There are 2 ways to deploy Headplane:

  • Integrated Mode (Recommended)

    Integrated mode unlocks all the features of Headplane and is the most feature-complete deployment method. It communicates with Headscale directly.

  • Simple Mode

    Simple mode does not include the automatic management of DNS and Headplane settings, requiring manual editing and reloading when making changes.

Contributing

Headplane is an open-source project and contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue. Also refer to the contributor guidelines for more info.

ACLs Machine Management

Copyright (c) 2025 Aarnav Tale