mirror of
https://github.com/YunoHost-Apps/headscale_ynh.git
synced 2024-09-03 19:25:53 +02:00
93 lines
3.7 KiB
Markdown
93 lines
3.7 KiB
Markdown
<!--
|
||
注意：此 README 由 <https://github.com/YunoHost/apps/tree/master/tools/readme_generator> 自动生成
|
||
请勿手动编辑。
|
||
-->
|
||
|
||
# YunoHost 上的 Headscale
|
||
|
||
[](https://ci-apps.yunohost.org/ci/apps/headscale/)  
|
||
|
||
[](https://install-app.yunohost.org/?app=headscale)
|
||
|
||
*[阅读此 README 的其它语言版本。](./ALL_README.md)*
|
||
|
||
> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Headscale。*
|
||
> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。*
|
||
|
||
## 概况
|
||
|
||
An open source, self-hosted implementation of the Tailscale control server.
|
||
|
||
### What is Tailscale
|
||
|
||
Tailscale is [a modern VPN](https://tailscale.com/) built on top of
|
||
[Wireguard](https://www.wireguard.com/).
|
||
It [works like an overlay network](https://tailscale.com/blog/how-tailscale-works/)
|
||
between the computers of your networks - using
|
||
[NAT traversal](https://tailscale.com/blog/how-nat-traversal-works/).
|
||
|
||
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)](https://tailscale.com/kb/1136/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's goal is to provide self-hosters and hobbyists with an open-source
|
||
server they can use for their projects and labs.
|
||
It implements a narrow scope, a single Tailnet, suitable for a personal use, or a small
|
||
open-source organisation.
|
||
|
||
### Features
|
||
|
||
|
||
- Full "base" support of Tailscale's features
|
||
- Configurable DNS
|
||
- [Split DNS](https://tailscale.com/kb/1054/dns/#using-dns-settings-in-the-admin-console)
|
||
- Node registration
|
||
- Single-Sign-On (via Open ID Connect)
|
||
- Pre authenticated key
|
||
- Taildrop (File Sharing)
|
||
- [Access control lists](https://tailscale.com/kb/1018/acls/)
|
||
- [MagicDNS](https://tailscale.com/kb/1081/magicdns)
|
||
- Support for multiple IP ranges in the tailnet
|
||
- Dual stack (IPv4 and IPv6)
|
||
- Routing advertising (including exit nodes)
|
||
- Ephemeral nodes
|
||
- Embedded [DERP server](https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp)
|
||
|
||
*from Headscale's README. See Links section below.*
|
||
|
||
|
||
**分发版本：** 0.22.3~ynh1
|
||
## 文档与资源
|
||
|
||
- 官方应用网站： <https://headscale.net/>
|
||
- 官方用户文档： <https://tailscale.com/kb/>
|
||
- 官方管理文档： <https://headscale.net/>
|
||
- 上游应用代码库： <https://github.com/juanfont/headscale>
|
||
- YunoHost 商店： <https://apps.yunohost.org/app/headscale>
|
||
- 报告 bug： <https://github.com/YunoHost-Apps/headscale_ynh/issues>
|
||
|
||
## 开发者信息
|
||
|
||
请向 [`testing` 分支](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing) 发送拉取请求。
|
||
|
||
如要尝试 `testing` 分支，请这样操作：
|
||
|
||
```bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
|
||
或
|
||
sudo yunohost app upgrade headscale -u https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
|
||
```
|
||
|
||
**有关应用打包的更多信息：** <https://yunohost.org/packaging_apps>
|