Skip to content

Commit

Permalink
Move flags after the command (#2100)
Browse files Browse the repository at this point in the history
The built-in help also shows flags to given after the command. Align
documentation examples accordingly.
  • Loading branch information
nblock authored Sep 4, 2024
1 parent f039caf commit e43d6a0
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/running-headscale-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ To register a machine when running `headscale` in a container, take the headscal

```shell
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
Expand All @@ -126,7 +126,7 @@ Generate a key using the command line:

```shell
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:
Expand Down
4 changes: 2 additions & 2 deletions docs/running-headscale-linux-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,15 @@ tailscale up --login-server YOUR_HEADSCALE_URL
Register the machine:

```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

Generate a key using the command line:

```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:
Expand Down
4 changes: 2 additions & 2 deletions docs/running-headscale-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@ tailscale up --login-server <YOUR_HEADSCALE_URL>
Register the machine:

```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

Generate a key using the command line:

```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
Expand Down
4 changes: 2 additions & 2 deletions docs/running-headscale-openbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,15 @@ tailscale up --login-server YOUR_HEADSCALE_URL
Register the machine:

```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

Generate a key using the command line:

```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:
Expand Down
4 changes: 2 additions & 2 deletions docs/running-headscale-sealos.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ 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:

```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

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
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:
Expand Down

0 comments on commit e43d6a0

Please sign in to comment.