juanfont/headscaleUn'implementazione open source e self-hosted del server di controllo di Tailscale.
Un'implementazione open source e auto-ospitata del server di controllo Tailscale.
Unisciti al nostro server Discord per una chat.
Nota: Seleziona sempre lo stesso tag GitHub della versione rilasciata che usi per assicurarti di avere la corretta configurazione di esempio. Il branch main potrebbe contenere modifiche non rilasciate. La documentazione è disponibile per le versioni stabili e di sviluppo:
Tailscale è una VPN moderna costruita su Wireguard. Funziona come una rete overlay tra i computer delle tue reti - utilizzando NAT traversal.
Tutto in Tailscale è Open Source, eccetto i client GUI per sistemi operativi proprietari (Windows e macOS/iOS) e il server di controllo.
Il server di controllo funge da punto di scambio delle chiavi pubbliche Wireguard per i nodi nella rete Tailscale. Assegna gli indirizzi IP dei client, crea i confini tra ogni utente, abilita la condivisione di macchine tra utenti ed espone le route pubblicizzate dei tuoi nodi.
Una rete Tailscale (tailnet) è una rete privata che Tailscale assegna a un utente in termini di utenti privati o un'organizzazione.
Headscale mira a implementare un'alternativa open source e auto-ospitata al server di controllo Tailscale. L'obiettivo di Headscale è fornire a chi si auto-ospita e agli hobbisti un server open source che possano usare per i loro progetti e laboratori. Implementa un ambito ristretto, una singola rete Tailscale (tailnet), adatta per uso personale o per una piccola organizzazione open source.
Se ti piace headscale e lo trovi utile, nel repository sono disponibili pulsanti di sponsorizzazione e donazione.
Consulta "Funzionalità" nella documentazione.
Consulta "Supporto per client e sistemi operativi" nella documentazione.
Ti preghiamo di notare che non supportiamo né incoraggiamo l'uso di proxy inversi e container per eseguire Headscale.
Dai un'occhiata alla documentazione.
Per gli utenti NixOS, un modulo è disponibile in nix/.
mainBuild di sviluppo dal branch main sono disponibili come immagini container e binari. Consulta la documentazione sulle build di sviluppo per i dettagli.
Questo progetto non è associato a Tailscale Inc.
Tuttavia, uno dei manutentori attivi di Headscale è impiegato da Tailscale e gli è permesso dedicare ore di lavoro al progetto. I contributi di questo manutentore sono revisionati dagli altri manutentori.
I manutentori collaborano nel definire la direzione del progetto. Il principio sottostante è servire la comunità di auto-ospitanti, appassionati e hobbisti - pur mantenendo un progetto sostenibile.
Leggi il file CONTRIBUTING.md.
Per contribuire a headscale avrai bisogno dell'ultima versione di Go e Buf (generatore Protobuf).
Raccomandiamo l'uso di Nix per impostare un ambiente di sviluppo. Questo può essere fatto con nix develop, che installerà gli strumenti e ti darà una shell. Questo garantisce che avrai lo stesso ambiente di sviluppo dei manutentori di headscale.
Per garantire una certa coerenza con un numero crescente di contributi, questo progetto ha adottato regole di linting e stile/formattazione:
Il codice Go è lintato con golangci-lint e formattato con golines (larghezza 88) e gofumpt. Per favore configura il tuo editor per eseguire gli strumenti durante lo sviluppo e assicurati di eseguire make lint e make fmt prima di inviare qualsiasi codice.
Il codice Proto è lintato con buf e formattato con clang-format.
La documentazione è formattata con mdformat.
Il resto (Markdown, YAML, ecc.) è formattato con prettier.
Controlla il file .golangci.yaml e il Makefile per vedere la configurazione specifica.
Installa e attiva:
nix develop
Alcune parti del progetto richiedono la generazione di codice Go da Protobuf (se vengono apportate modifiche in proto/) e deve essere (ri)generato con:
make generate
Nota: Per favore includi le modifiche da gen/ in un commit separato per facilitare la revisione.
Per eseguire i test:
make test
Per compilare il programma:
make build
Raccomandiamo l'uso di Nix per la gestione delle dipendenze per assicurarti di avere tutti gli strumenti necessari. Se preferisci gestire le dipendenze da solo, puoi usare Make direttamente:
Con Nix (consigliato):
nix develop
make test
make build
Con le tue dipendenze:
make test
make build
Il Makefile ti avviserà se mancano strumenti necessari e suggerirà di eseguire nix develop. Esegui make help per vedere tutti i target disponibili.
Fatto con contrib.rocks.