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

Run prettier

Browse source
This commit is contained in:
Kristoffer Dalby 2022-01-25 22:11:15 +00:00
parent bae7ba46de
commit 56b6528e3b
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/remote-cli.md
View file

@ -13,7 +13,7 @@
This documentation has the goal of showing a user how-to set control a `headscale` instance This documentation has the goal of showing a user how-to set control a `headscale` instance
from a remote machine with the `headscale` command line binary. from a remote machine with the `headscale` command line binary.
## Create an API key ## Create an API key
We need to create an API key to authenticate our remote `headscale` when using it from our workstation. We need to create an API key to authenticate our remote `headscale` when using it from our workstation.
@ -23,7 +23,7 @@ To create a API key, log into your `headscale` server and generate a key:
headscale apikeys create --expiration 90d headscale apikeys create --expiration 90d
``` ```
Copy the output of the command and save it for later. Please not that you can not retrieve a key again, Copy the output of the command and save it for later. Please not that you can not retrieve a key again,
if the key is lost, expire the old one, and create a new key. if the key is lost, expire the old one, and create a new key.
To list the keys currently assosicated with the server: To list the keys currently assosicated with the server:
@ -38,7 +38,6 @@ and to expire a key:
headscale apikeys expire --prefix "<PREFIX>" headscale apikeys expire --prefix "<PREFIX>"
``` ```
## Download and configure `headscale` ## Download and configure `headscale`
1. Download the latest [`headscale` binary from GitHub's release page](https://github.com/juanfont/headscale/releases): 1. Download the latest [`headscale` binary from GitHub's release page](https://github.com/juanfont/headscale/releases):
@ -59,7 +58,7 @@ export HEADSCALE_CLI_API_KEY="<API KEY FROM PREVIOUS STAGE>"
``` ```
This will tell the `headscale` binary to connect to a remote instance, instead of looking This will tell the `headscale` binary to connect to a remote instance, instead of looking
for a local instance (which is what it does on the server). for a local instance (which is what it does on the server).
The API key is needed to make sure that your are allowed to access the server. The key is _not_ The API key is needed to make sure that your are allowed to access the server. The key is _not_
needed when running directly on the server, as the connection is local. needed when running directly on the server, as the connection is local.
@ -81,5 +80,5 @@ Checklist:
- Make sure you have the _same_ `headscale` version on your server and workstation - Make sure you have the _same_ `headscale` version on your server and workstation
- Make sure you use version `0.13.0` or newer. - Make sure you use version `0.13.0` or newer.
- Verify that your TLS certificate is valid - Verify that your TLS certificate is valid
- If it is not valid, set the environment variable `HEADSCALE_CLI_INSECURE=true` to allow insecure certs. - If it is not valid, set the environment variable `HEADSCALE_CLI_INSECURE=true` to allow insecure certs.