- 该带图形界面控制台及Windows客户端、iOS客户端（计划中）的进一步开发更新，
- 已暂时转至“蜃境网络”兴趣小组私有仓库(https://github.com/MirageNetwork)，如有兴趣参与开发或体验的小伙伴请与我联系   

基于Headscale实现的具有WebUI的Tailscale控制服务器
注意 此版本可能与Headscale、Tailscale官方版本均有不兼容的情况，如需与官方版本并用需要考虑进行兼容性测试。

完成功能进度：

• 注册与登录
  • OIDC对接阿里云IDaaS登录
  • 对接阿里云手机号注册
  • 个人微信/QQ/微博登录【暂未考虑该方式是否需要提供注册环境】
  • 企业微信/钉钉对接登录【该方式似乎不需提供注册】
  • 组织或身份源管理
• 主界面框架与页头部用户基本信息展示、登出
• 设备页签
  • 设备列表信息展示
  • 单个设备详情页展示
  • 设备IP复制与设备控制菜单展示
  • 修改设备名
  • 启/停用设备密钥过期
  • 编辑设备子网路由
  • 删除设备
  • 编辑设备ACL标签
  • 分享设备
• 服务页签【暂不考虑】
• 用户页签【暂不考虑】
• ACL页签
• 日志页签【暂不考虑】
• DNS页签
  • 基本信息展示
  • 启/停用MagicDNS
  • 启/停用Override Local
  • 添加全球域名服务器
  • 添加split域名服务器
  • 修改/删除域名服务器
  • Basedomain解绑用户名以及可修改
  • split域名服务器可调整顺序
  • DNS厂商预植【暂不考虑】
  • HTTPS证书（BETA）【暂不考虑】
  • NextDNS支持【暂不考虑】
• 设置页签
  • 通用设置 （暂时不处理设备需预授权开关、身份提供商展示、用户组织名部分）
  • 特性功能开关
  • webhook【暂不考虑】
  • OAuth Client【暂不考虑】
  • 账单及用量显示
  • 密钥管理
    • 授权密钥管理
    • API密钥管理

以下是Headscale原README文件。
感谢Tailscale、Headscale及开源社区的共同努力。

---

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

Join our Discord server for a chat.

Note: Always select the same GitHub tag as the released version you use to ensure you have the correct example configuration and documentation. The main branch might contain unreleased changes.

What is Tailscale

Tailscale is a modern VPN built on top of Wireguard. It works like an overlay network between the computers of your networks - using NAT traversal.

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

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

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

Design goal

headscale aims to implement a self-hosted, open source alternative to the Tailscale control server. headscale has a narrower scope and an instance of headscale implements a single Tailnet, which is typically what a single organisation, or home/personal setup would use.

headscale uses terms that maps to Tailscale's control server, consult the glossary for explainations.

Support

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

If you would like to sponsor features, bugs or prioritisation, reach out to one of the maintainers.

Features

• Full "base" support of Tailscale's features
• Configurable DNS
  • Split DNS
• Node registration
  • Single-Sign-On (via Open ID Connect)
  • Pre authenticated key
• Taildrop (File Sharing)
• Access control lists
• MagicDNS
• Support for multiple IP ranges in the tailnet
• Dual stack (IPv4 and IPv6)
• Routing advertising (including exit nodes)
• Ephemeral nodes
• Embedded DERP server

Client OS support

OS	Supports headscale
Linux	Yes
OpenBSD	Yes
FreeBSD	Yes
macOS	Yes (see /apple on your headscale for more information)
Windows	Yes docs
Android	Yes docs
iOS	Not yet

Running headscale

Please have a look at the documentation under docs/.

Talks

• Fosdem 2023 (video): Headscale: How we are using integration testing to reimplement Tailscale
  • presented by Juan Font Alonso and Kristoffer Dalby

Disclaimer

1. We have nothing to do with Tailscale, or Tailscale Inc.
2. The purpose of Headscale is maintaining a working, self-hosted Tailscale control panel.

Contributing

To contribute to headscale you would need the lastest version of Go and Buf(Protobuf generator).

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

PRs and suggestions are welcome.

Code style

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

The Go code is linted with golangci-lint and formatted with golines (width 88) and gofumpt. Please configure your editor to run the tools while developing and make sure to run make lint and make fmt before committing any code.

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

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

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

Install development tools

• Go
• Buf
• Protobuf tools

Install and activate:

nix develop

Testing and building

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

make generate

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

To run the tests:

make test

To build the program:

nix build

or

make build

Contributors

Kristoffer Dalby	Juan Font	Adrien Raffin-Caboisse	Ward Vandewege	Jiang Zhu	Benjamin Roberts
Nico	e-zk	Justin Angel	Alessandro (Ale) Segala	unreality	ohdearaugustin
Moritz Poldrack	GrigoriyMikhalkin	Mike Lloyd	Anton Schubert	Niek van der Maas	Eugen Biegler
Azz	Even Holthe	Aaron Bieber	Igor Perepilitsyn	Laurent Marchaud	Fernando De Lucchi
Orville Q. Song	hdhoang	bravechamp	Deon Thomas	Jamie Greeff	ChibangLW
Mevan Samaratunga	Michael G.	Paul Tötterman	Samuel Lock	Stefan Majer	kevinlin
Artem Klevtsov	Casey Marshall	LiuHanCheng	Pavlos Vinieratos	Silver Bullet	Steven Honson
Victor Freire	lachy2849	thomas	Abraham Ingersoll	Andrei Pechkurov	Antoine POPINEAU
Aofei Sheng	Arnar	Arthur Woimbée	Bryan Stenson	Carson Yang	kundel
Felix Kronlage-Dammers	Felix Yan	JJGadgets	Jim Tittsler	Jonathan de Jong	Pierre Carru
Pontus N	Rasmus Moorats	rcursaru	Mend Renovate	Ryan Fowler	Shaanan Cohney
Stefan VanBuren	sophware	Tanner	Teteros	The Gitter Badger	Tianon Gravi
Till Hoffmann	Tjerk Woudsma	Yang Bin	Yujie Xia	Zachary N.	Zakhar Bessarab
Zhiyuan Zheng	Ziyuan Han	derelm	henning mueller	ignoramous	suhelen
sharkonet	manju-rn	pernila	phpmalik	Wakeful-Cloud	zy