myriation/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

Change the README to include the new releases

Browse source
This commit is contained in:
Juan Font 2021-06-14 22:21:54 +02:00 committed by GitHub
parent 6df90a922c
commit 9c276f33bd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -39,10 +39,8 @@ Suggestions/PRs welcomed!
## Running it ## Running it
1. Compile the headscale binary 1. Download the Headscale binary https://github.com/juanfont/headscale/releases, and place it somewhere in your PATH
```shell
make
```
2. (Optional, you can also use SQLite) Get yourself a PostgreSQL DB running 2. (Optional, you can also use SQLite) Get yourself a PostgreSQL DB running
@ -65,12 +63,12 @@ Suggestions/PRs welcomed!
4. Create a namespace (equivalent to a user in tailscale.com) 4. Create a namespace (equivalent to a user in tailscale.com)
```shell ```shell
./headscale namespace create myfirstnamespace headscale namespace create myfirstnamespace
``` ```
5. Run the server 5. Run the server
```shell ```shell
./headscale serve headscale serve
``` ```
6. Add your first machine 6. Add your first machine
@ -82,14 +80,14 @@ Suggestions/PRs welcomed!
8. In the server, register your machine to a namespace with the CLI 8. In the server, register your machine to a namespace with the CLI
```shell ```shell
./headscale -n myfirstnamespace node register YOURMACHINEKEY headscale -n myfirstnamespace node register YOURMACHINEKEY
``` ```
Alternatively, you can use Auth Keys to register your machines: Alternatively, you can use Auth Keys to register your machines:
1. Create an authkey 1. Create an authkey
```shell ```shell
./headscale -n myfirstnamespace preauthkey create --reusable --expiration 24h headscale -n myfirstnamespace preauthkey create --reusable --expiration 24h
``` ```
2. Use the authkey from your machine to register it 2. Use the authkey from your machine to register it
@ -162,7 +160,6 @@ To get a certificate automatically via [Let's Encrypt](https://letsencrypt.org/)
1. We have nothing to do with Tailscale, or Tailscale Inc. 1. We have nothing to do with Tailscale, or Tailscale Inc.
2. The purpose of writing this was to learn how Tailscale works. 2. The purpose of writing this was to learn how Tailscale works.
3. ~~I don't use Headscale myself.~~