Skip to content

Commit

Permalink
update docu
Browse files Browse the repository at this point in the history
  • Loading branch information
ohdearaugustin committed Sep 12, 2021
1 parent 3b97c7b commit 18867a4
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,16 @@ Suggestions/PRs welcomed!

## Running it

1. Download the Headscale binary https://github.com/juanfont/headscale/releases, and place it somewhere in your PATH

1. Download the Headscale binary https://github.com/juanfont/headscale/releases, and place it somewhere in your PATH or use the docker container

```shell
docker pull headscale/headscale:x.x.x
```

or
```shell
docker pull ghrc.io/juanfont/headscale:x.x.x
```

2. (Optional, you can also use SQLite) Get yourself a PostgreSQL DB running

Expand All @@ -65,11 +73,19 @@ Suggestions/PRs welcomed!
```shell
headscale namespaces create myfirstnamespace
```
or docker:
```shell
docker run -v ./private.key:/private.key -v ./config.json:/config.json headscale/headscale:x.x.x headscale namespace create myfirstnamespace
```

5. Run the server
```shell
headscale serve
```
or docker:
```shell
docker run -v $(pwd)/private.key:/private.key -v $(pwd)/config.json:/config.json -v $(pwd)/derb.yaml:/derb.yaml -p 127.0.0.1:8080:8080 headscale/headscale:x.x.x headscale serve
```

6. If you used tailscale.com before in your nodes, make sure you clear the tailscaled data folder
```shell
Expand All @@ -89,13 +105,21 @@ Suggestions/PRs welcomed!
```shell
headscale -n myfirstnamespace node register YOURMACHINEKEY
```
or docker:
```shell
docker run -v ./private.key:/private.key -v ./config.json:/config.json headscale/headscale:x.x.x headscale -n myfirstnamespace node register YOURMACHINEKEY
```

Alternatively, you can use Auth Keys to register your machines:

1. Create an authkey
```shell
headscale -n myfirstnamespace preauthkeys create --reusable --expiration 24h
```
or docker:
```shell
docker run -v ./private.key:/private.key -v ./config.json:/config.json headscale/headscale:x.x.x headscale -n myfirstnamespace preauthkeys create --reusable --expiration 24h
```

2. Use the authkey from your machine to register it
```shell
Expand Down
1 change: 0 additions & 1 deletion k8s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ Use "headscale [command] --help" for more information about a command.

# TODO / Ideas

- Github action to publish the docker image
- Interpolate `email:` option to the ClusterIssuer from site configuration.
This probably needs to be done with a transformer, kustomize vars don't seem to work.
- Add kustomize examples for cloud-native ingress, load balancer
Expand Down

0 comments on commit 18867a4

Please sign in to comment.