Skip to content

meerzulee/headscale-setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Headscale Setup

This repository provides a comprehensive setup for configuring Headscale with Caddy for reverse proxy and Headscale Admin web-apps for efficient management. The setup is based on the detailed guide available here.

Features

  • Docker Network Configuration: Easily set up a Docker network for seamless communication between containers.
  • Caddy Integration: Secure and configure your Headscale instance with Caddy as the reverse proxy, including optional Basic Auth for additional security.
  • Headscale Configuration: Customize your Headscale setup with a simple configuration file.
  • Admin UIs: Two powerful admin UI projects (headscale-ui and headscale-admin) for managing your Headscale instance efficiently.

Getting Started

  1. Create Docker Network:

    docker network create reverseproxy-nw
  2. Caddy Setup:

    • Replace domain with your actual domain in the Caddyfile.
    • Optionally, secure /web and /admin paths with Basic Auth:
      caddy hash-password -p <password>
      Add your username and hashed password to the Caddyfile.
  3. Headscale Setup:

    • Update config.yaml with your domain details.
  4. Admin UIs Configuration:

    • Generate API keys for both admin UI projects:
      docker exec headscale headscale apikeys create
    • Use the generated API keys in the configurations of headscale-ui and headscale-admin.

Contribution

Feel free to contribute by opening issues or submitting pull requests. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License.


Let me know if you need any more details or further adjustments!

About

Headscale + Web Admin + Caddy

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published