Skip to content

Commit 2116b38

Browse files
committed
update docs
1 parent 0127b02 commit 2116b38

File tree

1 file changed

+15
-28
lines changed

1 file changed

+15
-28
lines changed

mkdocs/docs/getting-started/tailnet.md

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -82,52 +82,39 @@ Example policy.json file:
8282

8383
## Connecting devices to your tailnet
8484

85-
How devices connect to your tailnet depends on your authentication configuration:
85+
There are two main methods to connect devices to your tailnet:
8686

87-
### Using OIDC authentication
87+
### Interactive login
8888

89-
If OIDC is configured, users with access (based on the IAM policy) connect via web authentication:
89+
When you have an OIDC provider configured, users can connect to their tailnet through an interactive web authentication flow:
9090

9191
```bash
9292
tailscale up --login-server=https://ionscale.example.com
9393
```
9494

95-
This opens a browser window where users authenticate with the OIDC provider. After successful authentication, if the user has access based on the tailnet's IAM policy, the device will be connected.
95+
This opens a browser window where the user authenticates with the OIDC provider. After successful authentication, if the user has access based on the tailnet's IAM policy, the device will be connected to the tailnet.
9696

97-
### Using auth keys
98-
99-
Auth keys allow devices to join a tailnet without interactive authentication. This is useful for automated deployments, servers, or environments where browser-based authentication isn't practical.
97+
!!! note
98+
Interactive login requires an OIDC provider to be configured on your ionscale instance.
10099

101-
There are two main scenarios for creating auth keys:
100+
### Using pre-authentication keys
102101

103-
#### Without OIDC configured
102+
Pre-authentication keys (auth keys) allow devices to join a tailnet without interactive authentication. This is useful for automated deployments, servers, or environments where browser-based authentication isn't practical.
104103

105-
When OIDC is not configured, a system administrator must create auth keys with appropriate tags:
104+
To create an auth key:
106105

107106
```bash
108-
# Create an auth key with a tag
107+
# Create an auth key
108+
ionscale auth-key create --tailnet "my-first-tailnet"
109+
110+
# Create an auth key with specific tags
109111
ionscale auth-key create --tailnet "my-first-tailnet" --tags "tag:server"
110112
```
111113

112114
The tags assigned to the key will determine what network access the device has once connected, based on your ACL rules.
113115

114-
#### With OIDC configured
115-
116-
When OIDC is configured, any user with access to a tailnet can create auth keys for that tailnet:
117-
118-
```bash
119-
# As an authenticated user, create an auth key
120-
ionscale auth-key create --tailnet "my-first-tailnet"
121-
```
122-
123-
Additionally, system administrators can create auth keys with specific tags:
124-
125-
```bash
126-
# As a system administrator, create a key with tags
127-
ionscale auth-key create --tailnet "my-first-tailnet" --tags "tag:database"
128-
```
129-
130-
#### Connecting with auth keys
116+
!!! note
117+
In environments with OIDC, users with access to a tailnet can create auth keys for that tailnet. Without OIDC, only system administrators can create keys.
131118

132119
To connect a device using an auth key:
133120

0 commit comments

Comments
 (0)