|
| 1 | +--- |
| 2 | +title: Integrate with Tailscale |
| 3 | +sidebar_label: Tailscale |
| 4 | +support_level: community |
| 5 | +--- |
| 6 | + |
| 7 | +## What is Tailscale |
| 8 | + |
| 9 | +> Tailscale is a mesh VPN service that creates secure, encrypted, peer-to-peer connections between devices across different networks using the WireGuard protocol. |
| 10 | +> |
| 11 | +> -- https://tailscale.com |
| 12 | +
|
| 13 | +## Preparation |
| 14 | + |
| 15 | +The following placeholders are used in this guide: |
| 16 | + |
| 17 | +- `authentik.company` is the FQDN of the authentik installation. |
| 18 | + |
| 19 | +:::info |
| 20 | +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. |
| 21 | + |
| 22 | +Use this JSON template for your WebFinger response: |
| 23 | + |
| 24 | +```json |
| 25 | +{ |
| 26 | + "links": [ |
| 27 | + { |
| 28 | + "href": "https://authentik.company", |
| 29 | + "rel": "http://openid.net/specs/connect/1.0/issuer" |
| 30 | + } |
| 31 | + ], |
| 32 | + "subject": "acct:[email protected]" |
| 33 | +} |
| 34 | +``` |
| 35 | + |
| 36 | +**Important: ** Replace `[email protected]` with the administrator email that you will use when creating your Tailnet. The domain in the email address must match; the domain where the WebFinger endpoint is served, and the domain you will use for Tailscale. |
| 37 | +::: |
| 38 | + |
| 39 | +:::note |
| 40 | +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. |
| 41 | +::: |
| 42 | + |
| 43 | +## authentik configuration |
| 44 | + |
| 45 | +To support the integration of Tailscale with authentik, you need to create an application/provider pair in authentik. |
| 46 | + |
| 47 | +### Create an application and provider in authentik |
| 48 | + |
| 49 | +1. Log in to authentik as an administrator and open the authentik Admin interface. |
| 50 | +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.) |
| 51 | + |
| 52 | + - **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. |
| 53 | + - **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type. |
| 54 | + - **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. |
| 55 | + - Note the **Client ID** and **Client Secret** values because they will be required later. |
| 56 | + - Set a `Strict` redirect URI to `https://login.tailscale.com/a/oauth_response`. |
| 57 | + - Select any available signing key. |
| 58 | + - **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. |
| 59 | + |
| 60 | +3. Click **Submit** to save the new application and provider. |
| 61 | + |
| 62 | +## Tailscale configuration |
| 63 | + |
| 64 | +1. Visit [Tailscale's sign up page](https://login.tailscale.com/start) and click **Sign up with OIDC**. |
| 65 | +2. Enter the administrator email, select `authentik` as the identity provider type, and click **Get OIDC Issuer**. |
| 66 | +3. Set the following configurations: |
| 67 | + - **Client ID**: enter the Client ID copied from authentik. |
| 68 | + - **Client secret**: enter the Client secret copied from authentik. |
| 69 | + - **Prompts**: keep the default value `consent`. |
| 70 | +4. Click **Sign up with OIDC** and follow the prompts to complete the Tailscale-specific configuration. |
| 71 | + |
| 72 | +## Configuration verification |
| 73 | + |
| 74 | +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. |
| 75 | + |
| 76 | +## Resources |
| 77 | + |
| 78 | +- [Tailscale SSO documentation](https://tailscale.com/kb/1240/sso-custom-oidc) |
0 commit comments