Skip to content

[Headplane] Introduce guide for setup & usage as Headscale web admin management gui #1914

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

dotWee
Copy link
Contributor

@dotWee dotWee commented Jul 6, 2025

Headplane is a Node.js based admin interface for Headscale (self-hosted Tailscale coordinator).

:align: center

#########
Headscale
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The headscale guide shouldn't be in this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would force-push once the Headscale guide is merged, since this guide references the Headscale guide.

Initial reason for including the Headscale commits were to prevent linting errors (because of invalid references). :)

License
=======

Headplane is released under the _[MIT License](https://github.com/tale/headplane/blob/main/LICENSE)_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link doesn't render correctly. Compare to the Headplane_ link above and it's reference at the end of the file to see how to set links correctly.


All relevant legal information can be found here:

* https://github.com/tale/headplane/blob/main/LICENSE
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a duplicate of the (broken) link above.

=============

- Node.js 22 LTS or newer (see :manual:`Node.js <lang-nodejs>`)
- PNPM 10.x (see https://pnpm.io/installation)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please turn this into a properly formatted link (see above)


- Node.js 22 LTS or newer (see :manual:`Node.js <lang-nodejs>`)
- PNPM 10.x (see https://pnpm.io/installation)
- A running Headscale instance (see :lab:`Headscale <guide_headscale>`) on the same Uberspace account
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll stop the review here (for now) as this guide depends on #1904 which still needs work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants