juanfont/headscaleTailscale 제어 서버의 오픈 소스, 자체 호스팅 구현
Tailscale 컨트롤 서버의 오픈 소스, 자체 호스팅 구현체입니다.
채팅을 위해 Discord 서버에 가입하세요.
참고: 항상 사용 중인 릴리스 버전과 동일한 GitHub 태그를 선택하여 올바른 예제 구성을 사용하세요. main 브랜치에는 릴리스되지 않은 변경 사항이 포함될 수 있습니다. 문서는 안정 버전과 개발 버전 모두 제공됩니다:
Tailscale은 Wireguard 기반으로 구축된 현대적인 VPN입니다. 네트워크의 컴퓨터 간에 오버레이 네트워크처럼 작동하며, NAT traversal을 사용합니다.
Tailscale의 모든 것은 오픈 소스이지만, 독점 OS(Windows, macOS/iOS)용 GUI 클라이언트와 컨트롤 서버는 예외입니다.
컨트롤 서버는 Tailscale 네트워크의 노드 간 Wireguard 공개 키 교환 지점 역할을 합니다. 클라이언트의 IP 주소를 할당하고, 각 사용자 간 경계를 만들며, 사용자 간 머신 공유를 가능하게 하고, 노드의 알려진 경로를 노출합니다.
Tailscale 네트워크(tailnet)는 Tailscale이 개인 사용자 또는 조직에 할당하는 사설 네트워크입니다.
Headscale은 Tailscale 컨트롤 서버의 자체 호스팅 오픈 소스 대안을 구현하는 것을 목표로 합니다. Headscale의 목표는 자체 호스터와 취미 사용자들이 자신의 프로젝트와 연구실에서 사용할 수 있는 오픈 소스 서버를 제공하는 것입니다. 개인 사용이나 소규모 오픈 소스 조직에 적합한 단일 Tailscale 네트워크(tailnet)라는 좁은 범위를 구현합니다.
headscale이 마음에 들고 유용하다면, 저장소에 후원 및 기부 버튼이 있습니다.
문서의 "기능"을 참조하세요.
문서의 "클라이언트 및 운영 체제 지원"을 참조하세요.
Headscale 실행 시 리버스 프록시나 컨테이너 사용을 지원하거나 권장하지 않습니다.
문서를 확인하세요.
NixOS 사용자의 경우 nix/에 모듈이 있습니다.
main 브랜치 빌드main 브랜치의 개발 빌드는 컨테이너 이미지 및 바이너리로 제공됩니다. 자세한 내용은
개발 빌드 문서를 참조하세요.
이 프로젝트는 Tailscale Inc.와 관련이 없습니다.
그러나 Headscale의 활성 유지 관리자 중 한 명이 Tailscale에 고용되어 있으며, 근무 시간 중 프로젝트에 기여할 수 있습니다. 이 유지 관리자의 기여는 다른 유지 관리자에 의해 검토됩니다.
유지 관리자들은 프로젝트 방향을 설정하기 위해 협력합니다. 기본 원칙은 자체 호스터, 열성팬 및 취미 사용자 커뮤니티에 서비스를 제공하면서 지속 가능한 프로젝트를 유지하는 것입니다.
CONTRIBUTING.md 파일을 읽어주세요.
headscale에 기여하려면 최신 버전의 Go와 Buf(Protobuf 생성기)가 필요합니다.
개발 환경 설정을 위해 Nix 사용을 권장합니다. nix develop을 통해 도구를 설치하고
셸을 얻을 수 있습니다. 이렇게 하면 headscale 유지 관리자와 동일한 개발 환경을 보장합니다.
기여가 증가함에 따라 일관성을 유지하기 위해 이 프로젝트는 린팅 및 스타일/포맷 규칙을 채택했습니다.
Go 코드는 golangci-lint로 린트되고
golines(너비 88) 및
gofumpt로 포맷됩니다.
개발 중 도구를 실행하도록 편집기를 구성하고 코드를 커밋하기 전에 make lint 및 make fmt를 실행하세요.
Proto 코드는 buf로 린트되고
clang-format으로 포맷됩니다.
문서는 mdformat으로 포맷됩니다.
나머지(Markdown, YAML 등)는 prettier로 포맷됩니다.
구체적인 구성은 .golangci.yaml 및 Makefile을 확인하세요.
설치 및 활성화:
nix develop
프로젝트의 일부는 Protobuf(proto/에서 변경된 경우)에서 Go 코드를 생성해야 하며
다음 명령으로 (재)생성해야 합니다:
make generate
참고: gen/의 변경 사항은 검토를 쉽게 하기 위해 별도의 커밋에 포함하세요.
테스트를 실행하려면:
make test
프로그램을 빌드하려면:
make build
종속성 관리를 위해 Nix 사용을 권장하여 필요한 모든 도구를 갖추도록 합니다. 직접 종속성을 관리하려면 Make를 직접 사용할 수 있습니다:
Nix 사용 (권장):
nix develop
make test
make build
자체 종속성 사용:
make test
make build
Makefile은 필요한 도구가 없으면 경고하고 nix develop 실행을 제안합니다.
make help를 실행하여 사용 가능한 모든 대상을 확인하세요.
contrib.rocks로 제작됨