From 56b6528e3b3125d460437c22529d381b7f311b7d Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Tue, 25 Jan 2022 22:11:15 +0000 Subject: [PATCH] Run prettier --- docs/remote-cli.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/remote-cli.md b/docs/remote-cli.md index 55193620..3d4bbafb 100644 --- a/docs/remote-cli.md +++ b/docs/remote-cli.md @@ -13,7 +13,7 @@ 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. -## 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. @@ -23,7 +23,7 @@ To create a API key, log into your `headscale` server and generate a key: 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. To list the keys currently assosicated with the server: @@ -38,7 +38,6 @@ and to expire a key: headscale apikeys expire --prefix "" ``` - ## Download and configure `headscale` 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="" ``` 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_ 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 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.