{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/223", "result": {"data":{"issuesJson":{"id":"a72c805e-7a9c-57fc-b6f0-dcc4ad48dd91","title":"juanfont/headscale: Tailscale控制服务器的开源、自托管实现","number":223,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposjuanfont/headscale
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

\"headscale

\n

\"ci\"

\n

An open source, self-hosted implementation of the Tailscale control server.

\n

Join our Discord server for a chat.

\n

Note: Always select the same GitHub tag as the released version you use
\nto ensure you have the correct example configuration. The main branch might
\ncontain unreleased changes. The documentation is available for stable and
\ndevelopment versions:

\n\n

What is Tailscale

\n

Tailscale is a modern VPN built on top of
\nWireguard.
\nIt works like an overlay network
\nbetween the computers of your networks - using
\nNAT traversal.

\n

Everything in Tailscale is Open Source, except the GUI clients for proprietary OS
\n(Windows and macOS/iOS), and the control server.

\n

The control server works as an exchange point of Wireguard public keys for the
\nnodes in the Tailscale network. It assigns the IP addresses of the clients,
\ncreates the boundaries between each user, enables sharing machines between users,
\nand exposes the advertised routes of your nodes.

\n

A Tailscale network (tailnet) is private
\nnetwork which Tailscale assigns to a user in terms of private users or an
\norganisation.

\n

Design goal

\n

Headscale aims to implement a self-hosted, open source alternative to the
\nTailscale control server. Headscale's goal is to
\nprovide self-hosters and hobbyists with an open-source server they can use for
\ntheir projects and labs. It implements a narrow scope, a single Tailscale
\nnetwork (tailnet), suitable for a personal use, or a small open-source
\norganisation.

\n

Supporting Headscale

\n

If you like headscale and find it useful, there is a sponsorship and donation
\nbuttons available in the repo.

\n

Features

\n

Please see \"Features\" in the documentation.

\n

Client OS support

\n

Please see \"Client and operating system support\" in the documentation.

\n

Running headscale

\n

Please note that we do not support nor encourage the use of reverse proxies
\nand container to run Headscale.

\n

Please have a look at the documentation.

\n

Talks

\n\n

Disclaimer

\n

This project is not associated with Tailscale Inc.

\n

However, one of the active maintainers for Headscale is employed by Tailscale and he is allowed to spend work hours contributing to the project. Contributions from this maintainer are reviewed by other maintainers.

\n

The maintainers work together on setting the direction for the project. The underlying principle is to serve the community of self-hosters, enthusiasts and hobbyists - while having a sustainable project.

\n

Contributing

\n

Please read the CONTRIBUTING.md file.

\n

Requirements

\n

To contribute to headscale you would need the latest version of Go
\nand Buf (Protobuf generator).

\n

We recommend using Nix to setup a development environment. This can
\nbe done with nix develop, which will install the tools and give you a shell.
\nThis guarantees that you will have the same dev env as headscale maintainers.

\n

Code style

\n

To ensure we have some consistency with a growing number of contributions,
\nthis project has adopted linting and style/formatting rules:

\n

The Go code is linted with golangci-lint and
\nformatted with golines (width 88) and
\ngofumpt.
\nPlease configure your editor to run the tools while developing and make sure to
\nrun make lint and make fmt before committing any code.

\n

The Proto code is linted with buf and
\nformatted with clang-format.

\n

The rest (Markdown, YAML, etc) is formatted with prettier.

\n

Check out the .golangci.yaml and Makefile to see the specific configuration.

\n

Install development tools

\n\n

Install and activate:

\n
nix develop
\n

Testing and building

\n

Some parts of the project require the generation of Go code from Protobuf
\n(if changes are made in proto/) and it must be (re-)generated with:

\n
make generate
\n

Note: Please check in changes from gen/ in a separate commit to make it easier to review.

\n

To run the tests:

\n
make test
\n

To build the program:

\n
nix build
\n

or

\n
make build
\n

Contributors

\n\n \n\n

Made with contrib.rocks.

","updatedAt":"2025-05-21T16:01:32Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"VPN","color":"da3863"}},{"node":{"name":"juanfont","color":"1ea777"}}]},"comments":{"edges":[]}}},"pageContext":{"number":223,"previous":{"title":"headlamp-k8s/headlamp: Headlamp 是一个易于使用且可扩展的 Kubernetes Web UI。","number":222},"next":{"title":"LeslieLeung/heimdallr: 一个非常轻量的通知网关，可以聚合各种推送渠道，使用 Serverless 部署，几乎零成本运行。","number":224}}}, "staticQueryHashes": ["151096407","2861350382"]}