Skip to content

[Headscale] Add guide with setup and usage #1904

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 1 commit into
base: main
Choose a base branch
from

Conversation

dotWee
Copy link
Contributor

@dotWee dotWee commented May 25, 2025

This pull request introduces a new guide for setting up and using Headscale, an open-source, self-hosted implementation of the Tailscale control server. The guide provides detailed instructions on installation, configuration, and integration with Uberspace's web backend, including prerequisites, setup steps, and usage examples.

New Guide for Headscale Setup and Usage:

  • Guide Overview and Licensing:

    • Added an introduction to Headscale, highlighting its purpose as a self-hosted Tailscale control server using the WireGuard protocol.
    • Included licensing information (BSD-3-Clause License) and links to the official Headscale GitHub repository.
  • Installation Instructions:

    • Detailed steps for downloading and installing the Headscale binary, setting up directories, and configuring the application.
  • Configuration for Uberspace Integration:

    • Provided specific configuration details for running Headscale behind Uberspace's web backend, including disabling TLS and enabling WebSocket support.
  • Daemon Setup and Testing:

    • Instructions for creating and managing a supervisord configuration file to run Headscale as a service, with guidance on testing and troubleshooting.
  • Initial Usage and Updates:

    • Explained how to create users, generate preauth keys, and register devices with Headscale

@dotWee dotWee changed the title Add guide for Headscale setup and usage [Headscale] Add guide with setup and usage May 25, 2025
@dotWee
Copy link
Contributor Author

dotWee commented Jun 2, 2025

@luto @nichtmax is there anything left to do to get this merged?

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.

1 participant