-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
website/integrations: tailscale #14499
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 12 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
15bad6c
init
dominic-r 8bc0805
wording
dominic-r 0199af5
lint
dominic-r d011875
Update website/integrations/services/tailscale/index.md
dominic-r d2fba5a
Dewi's suggestions
dominic-r b75a7ca
still mention that its a placeholder
dominic-r f6ac196
Merge branch 'goauthentik:main' into sdko/ts-integr
dominic-r 6d7af8c
Merge branch 'goauthentik:main' into sdko/ts-integr
dominic-r 22fe03b
fix
dominic-r 7d769a1
Update website/integrations/services/tailscale/index.md
dominic-r ed0f8c4
mv to end
dominic-r e477012
indent
dominic-r 898dfca
Update website/integrations/services/tailscale/index.md
dominic-r f5eb5c0
Update website/integrations/services/tailscale/index.md
dominic-r e2b84c4
tweak to bump build
tanberry fadfb7a
Merge branch 'main' into sdko/ts-integr
tanberry e0ecf4a
another tweak to bump build
tanberry File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| title: Integrate with Tailscale | ||
| sidebar_label: Tailscale | ||
| support_level: community | ||
| --- | ||
|
|
||
| ## What is Tailscale | ||
|
|
||
| > Tailscale is a mesh VPN service that creates secure, encrypted, peer-to-peer connections between devices across different networks using the WireGuard protocol. | ||
| > | ||
| > -- https://tailscale.com | ||
|
|
||
| ## Preparation | ||
|
|
||
| The following placeholders are used in this guide: | ||
|
|
||
| - `authentik.company` is the FQDN of the authentik installation. | ||
|
|
||
| :::info | ||
| Tailscale requires a properly configured WebFinger endpoint at `.well-known/webfinger` on the domain used for your email. Set this up according to your web server or application specifications. | ||
|
dominic-r marked this conversation as resolved.
|
||
|
|
||
| Use this JSON template for your WebFinger response: | ||
|
|
||
| ```json | ||
| { | ||
| "links": [ | ||
| { | ||
| "href": "https://authentik.company", | ||
| "rel": "http://openid.net/specs/connect/1.0/issuer" | ||
| } | ||
| ], | ||
| "subject": "acct:your@email.com" | ||
| } | ||
| ``` | ||
|
|
||
| **Important:** Replace `your@email.com` with the administrator email you'll use when creating your Tailnet. The domain in the email address must match both the domain where the WebFinger endpoint is served and the domain you will use for Tailscale. This email must match exactly in both the WebFinger configuration and during Tailscale setup. | ||
|
dominic-r marked this conversation as resolved.
Outdated
|
||
| ::: | ||
|
|
||
| :::note | ||
| This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application. | ||
| ::: | ||
|
|
||
| ## authentik configuration | ||
|
|
||
| To support the integration of Tailscale with authentik, you need to create an application/provider pair in authentik. | ||
|
|
||
| ### Create an application and provider in authentik | ||
|
|
||
| 1. Log in to authentik as an administrator and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Applications** and click **Create with Provider** to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.) | ||
|
|
||
| - **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. | ||
| - **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type. | ||
| - **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations. | ||
| - Note the **Client ID**,**Client Secret**, and **slug** values because they will be required later. | ||
|
dominic-r marked this conversation as resolved.
Outdated
dominic-r marked this conversation as resolved.
Outdated
|
||
| - Set a `Strict` redirect URI to `https://login.tailscale.com/a/oauth_response`. | ||
| - Select any available signing key. | ||
| - **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page. | ||
|
|
||
| 3. Click **Submit** to save the new application and provider. | ||
|
|
||
| ## Tailscale configuration | ||
|
|
||
| 1. Visit the [Tailscale sign up page](https://login.tailscale.com/start) and click **Sign up with OIDC**. | ||
| 2. Enter the administrator email, select `authentik` as the identity provider type, and click **Get OIDC Issuer**. | ||
| 3. Set the following configurations: | ||
| - **Client ID**: enter the Client ID copied from authentik. | ||
| - **Client secret**: enter the Client secret copied from authentik. | ||
| - **Prompts**: keep the default value `consent`. | ||
| 4. Click **Sign up with OIDC** and follow the prompts to complete the Tailscale-specific configuration. | ||
|
|
||
| ## Configuration verification | ||
|
|
||
| To verify the integration with Tailscale, log out and attempt to log back in using an email address from your configured SSO domain. You should be redirected to your authentik instance and after successfully logging in, you should be redirected to the Tailscale dashboard. | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Tailscale SSO documentation](https://tailscale.com/kb/1240/sso-custom-oidc) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.