Move flags after the command (#2100)

The built-in help also shows flags to given after the command. Align
documentation examples accordingly.
This commit is contained in:
nblock 2024-09-04 14:38:38 +02:00 committed by GitHub
parent f039caf134
commit e43d6a0361
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 10 additions and 10 deletions

View file

@ -117,7 +117,7 @@ To register a machine when running `headscale` in a container, take the headscal
```shell ```shell
docker exec headscale \ docker exec headscale \
headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY> headscale nodes register --user myfirstuser --key <YOUR_MACHINE_KEY>
``` ```
### Register machine using a pre authenticated key ### Register machine using a pre authenticated key
@ -126,7 +126,7 @@ Generate a key using the command line:
```shell ```shell
docker exec headscale \ docker exec headscale \
headscale --user myfirstuser preauthkeys create --reusable --expiration 24h headscale preauthkeys create --user myfirstuser --reusable --expiration 24h
``` ```
This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command: This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command:

View file

@ -92,7 +92,7 @@ tailscale up --login-server YOUR_HEADSCALE_URL
Register the machine: Register the machine:
```shell ```shell
headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY> headscale nodes register --user myfirstuser --key <YOUR_MACHINE_KEY>
``` ```
### Register machine using a pre authenticated key ### Register machine using a pre authenticated key
@ -100,7 +100,7 @@ headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY>
Generate a key using the command line: Generate a key using the command line:
```shell ```shell
headscale --user myfirstuser preauthkeys create --reusable --expiration 24h headscale preauthkeys create --user myfirstuser --reusable --expiration 24h
``` ```
This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command: This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command:

View file

@ -78,7 +78,7 @@ tailscale up --login-server <YOUR_HEADSCALE_URL>
Register the machine: Register the machine:
```shell ```shell
headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY> headscale nodes register --user myfirstuser --key <YOUR_MACHINE_KEY>
``` ```
### Register machine using a pre authenticated key ### Register machine using a pre authenticated key
@ -86,7 +86,7 @@ headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY>
Generate a key using the command line: Generate a key using the command line:
```shell ```shell
headscale --user myfirstuser preauthkeys create --reusable --expiration 24h headscale preauthkeys create --user myfirstuser --reusable --expiration 24h
``` ```
This will return a pre-authenticated key that is used to This will return a pre-authenticated key that is used to

View file

@ -129,7 +129,7 @@ tailscale up --login-server YOUR_HEADSCALE_URL
Register the machine: Register the machine:
```shell ```shell
headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY> headscale nodes register --user myfirstuser --key <YOUR_MACHINE_KEY>
``` ```
### Register machine using a pre authenticated key ### Register machine using a pre authenticated key
@ -137,7 +137,7 @@ headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY>
Generate a key using the command line: Generate a key using the command line:
```shell ```shell
headscale --user myfirstuser preauthkeys create --reusable --expiration 24h headscale preauthkeys create --user myfirstuser --reusable --expiration 24h
``` ```
This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command: This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command:

View file

@ -41,7 +41,7 @@ tailscale up --login-server YOUR_HEADSCALE_URL
To register a machine when running headscale in [Sealos](https://sealos.io), click on 'Terminal' button on the right side of the headscale application's detail page to access the Terminal of the headscale application, then take the headscale command: To register a machine when running headscale in [Sealos](https://sealos.io), click on 'Terminal' button on the right side of the headscale application's detail page to access the Terminal of the headscale application, then take the headscale command:
```bash ```bash
headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY> headscale nodes register --user myfirstuser --key <YOUR_MACHINE_KEY>
``` ```
### Register machine using a pre authenticated key ### Register machine using a pre authenticated key
@ -49,7 +49,7 @@ headscale --user myfirstuser nodes register --key <YOUR_MACHINE_KEY>
click on 'Terminal' button on the right side of the headscale application's detail page to access the Terminal of the headscale application, then generate a key using the command line: click on 'Terminal' button on the right side of the headscale application's detail page to access the Terminal of the headscale application, then generate a key using the command line:
```bash ```bash
headscale --user myfirstuser preauthkeys create --reusable --expiration 24h headscale preauthkeys create --user myfirstuser --reusable --expiration 24h
``` ```
This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command: This will return a pre-authenticated key that can be used to connect a node to `headscale` during the `tailscale` command: