{"id":13424793,"url":"https://github.com/juanfont/headscale","last_synced_at":"2025-05-12T16:24:47.676Z","repository":{"id":37031749,"uuid":"273871859","full_name":"juanfont/headscale","owner":"juanfont","description":"An open source, self-hosted implementation of the Tailscale control server","archived":false,"fork":false,"pushed_at":"2025-05-11T00:24:17.000Z","size":14045,"stargazers_count":28323,"open_issues_count":105,"forks_count":1522,"subscribers_count":169,"default_branch":"main","last_synced_at":"2025-05-12T16:24:24.347Z","etag":null,"topics":["tailscale","tailscale-control-server","tailscale-server","wireguard"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juanfont.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"ko_fi":"headscale"}},"created_at":"2020-06-21T09:21:05.000Z","updated_at":"2025-05-12T15:17:25.000Z","dependencies_parsed_at":"2023-12-31T01:31:29.293Z","dependency_job_id":"195c6ed4-04b0-410a-bc3e-838cfe722659","html_url":"https://github.com/juanfont/headscale","commit_stats":{"total_commits":2389,"total_committers":177,"mean_commits":"13.497175141242938","dds":0.7170364169108414,"last_synced_commit":"5f9c26930ce796284a8fc7ad167f76e187813d64"},"previous_names":[],"tags_count":141,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanfont%2Fheadscale","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanfont%2Fheadscale/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanfont%2Fheadscale/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanfont%2Fheadscale/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juanfont","download_url":"https://codeload.github.com/juanfont/headscale/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253774875,"owners_count":21962244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["tailscale","tailscale-control-server","tailscale-server","wireguard"],"created_at":"2024-07-31T00:00:59.560Z","updated_at":"2025-05-12T16:24:47.669Z","avatar_url":"https://github.com/juanfont.png","language":"Go","readme":"![headscale logo](./docs/logo/headscale3_header_stacked_left.png)\n\n![ci](https://github.com/juanfont/headscale/actions/workflows/test.yml/badge.svg)\n\nAn open source, self-hosted implementation of the Tailscale control server.\n\nJoin our [Discord server](https://discord.gg/c84AZQhmpx) for a chat.\n\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* [Documentation for the stable version](https://headscale.net/stable/)\n* [Documentation for the development version](https://headscale.net/development/)\n\n## What is Tailscale\n\nTailscale is [a modern VPN](https://tailscale.com/) built on top of\n[Wireguard](https://www.wireguard.com/).\nIt [works like an overlay network](https://tailscale.com/blog/how-tailscale-works/)\nbetween the computers of your networks - using\n[NAT traversal](https://tailscale.com/blog/how-nat-traversal-works/).\n\nEverything in Tailscale is Open Source, except the GUI clients for proprietary OS\n(Windows and macOS/iOS), and the control server.\n\nThe 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\nA [Tailscale network (tailnet)](https://tailscale.com/kb/1136/tailnet/) is private\nnetwork which Tailscale assigns to a user in terms of private users or an\norganisation.\n\n## Design goal\n\nHeadscale aims to implement a self-hosted, open source alternative to the\n[Tailscale](https://tailscale.com/) 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\n## Supporting Headscale\n\nIf you like `headscale` and find it useful, there is a sponsorship and donation\nbuttons available in the repo.\n\n## Features\n\nPlease see [\"Features\" in the documentation](https://headscale.net/stable/about/features/).\n\n## Client OS support\n\nPlease see [\"Client and operating system support\" in the documentation](https://headscale.net/stable/about/clients/).\n\n## Running headscale\n\n**Please note that we do not support nor encourage the use of reverse proxies\nand container to run Headscale.**\n\nPlease have a look at the [`documentation`](https://headscale.net/stable/).\n\n## Talks\n\n- Fosdem 2023 (video): [Headscale: How we are using integration testing to reimplement Tailscale](https://fosdem.org/2023/schedule/event/goheadscale/)\n  - presented by Juan Font Alonso and Kristoffer Dalby\n\n## Disclaimer\n\nThis project is not associated with Tailscale Inc.\n\nHowever, one of the active maintainers for Headscale [is employed by Tailscale](https://tailscale.com/blog/opensource) and he is allowed to spend work hours contributing to the project. Contributions from this maintainer are reviewed by other maintainers.\n\nThe 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\n## Contributing\n\nPlease read the [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n\n### Requirements\n\nTo contribute to headscale you would need the latest version of [Go](https://golang.org)\nand [Buf](https://buf.build) (Protobuf generator).\n\nWe recommend using [Nix](https://nixos.org/) 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\n### Code style\n\nTo ensure we have some consistency with a growing number of contributions,\nthis project has adopted linting and style/formatting rules:\n\nThe **Go** code is linted with [`golangci-lint`](https://golangci-lint.run) and\nformatted with [`golines`](https://github.com/segmentio/golines) (width 88) and\n[`gofumpt`](https://github.com/mvdan/gofumpt).\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\nThe **Proto** code is linted with [`buf`](https://docs.buf.build/lint/overview) and\nformatted with [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html).\n\nThe **rest** (Markdown, YAML, etc) is formatted with [`prettier`](https://prettier.io).\n\nCheck out the `.golangci.yaml` and `Makefile` to see the specific configuration.\n\n### Install development tools\n\n- Go\n- Buf\n- Protobuf tools\n\nInstall and activate:\n\n```shell\nnix develop\n```\n\n### Testing and building\n\nSome 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\n```shell\nmake generate\n```\n\n**Note**: Please check in changes from `gen/` in a separate commit to make it easier to review.\n\nTo run the tests:\n\n```shell\nmake test\n```\n\nTo build the program:\n\n```shell\nnix build\n```\n\nor\n\n```shell\nmake build\n```\n\n## Contributors\n\n\u003ca href=\"https://github.com/juanfont/headscale/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=juanfont/headscale\" /\u003e\n\u003c/a\u003e\n\nMade with [contrib.rocks](https://contrib.rocks).\n","funding_links":["https://ko-fi.com/headscale"],"categories":["Go","Proxy and VPN","Install from Source","others","🤖 AI \u0026 Machine Learning","HarmonyOS","网络服务","VPN","Repos","Software","Table of Contents","Transport-layer defenses","Projects"],"sub_categories":["Python","Remote Access","Windows Manager","网络服务_其他","VPN","Overlay and Virtual Private Networks (VPNs)","Mesh Network"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuanfont%2Fheadscale","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuanfont%2Fheadscale","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuanfont%2Fheadscale/lists"}