Skip to content
Install

Reach apps over Tailscale

Put an app on your Tailscale network when only your own devices should reach it, such as an internal tool or an admin panel. Devices on your tailnet reach the app at a private address, so the app needs no public URL or open port.

Orchard runs a Tailscale proxy pod next to the app, in the same namespace. The proxy joins your tailnet with your auth key and forwards traffic to the app’s Service. The app’s own pods do not change or restart.

  • A Tailscale account.
  • Edit access to the project.
  • On an instance that uses PostHog, the Tailscale feature turned on for your account. Go to Account settings > Early access. On an instance with no PostHog key, the feature is always on.

An auth key connects your Orchard account to your tailnet. Each person links their own key.

  1. In the Tailscale admin console, go to Settings > Keys and select Generate auth key.
  2. Turn on Reusable and Ephemeral. Leave the tags empty.
  3. Set the key to expire in 90 days, the longest period Tailscale allows.
  4. Copy the key. It starts with tskey-auth-.
  1. Go to Account settings > Connections.
  2. In Tailscale, select Connect.
  3. Paste the auth key and select Connect.

Orchard encrypts the key before it stores it.

  1. Open the app and go to the Network tab.
  2. In Ports, turn on the Tailscale switch.

The address appears in the same row when the proxy joins the tailnet.

The device name on your tailnet is <app>-<namespace>. With MagicDNS on, the address is:

<app>-<namespace>.<tailnet>.ts.net

Tailscale access controls apply to this device in the same way as to any other device on your tailnet.

  1. Open the app and go to the Network tab.
  2. In Ports, turn off the Tailscale switch.

Orchard deletes the proxy pod and its copy of the auth key. Orchard also removes the proxy when you delete the app or its project.

Go to Account settings > Connections, and in Tailscale, select Disconnect. In the CLI, run orchard tailscale unlink.

A proxy uses its auth key when it joins your tailnet. After the key expires, a proxy that has to join again fails, and new apps cannot join.

To replace the key:

  1. Generate a new auth key and link your tailnet again. The new key replaces the old one on your account.
  2. For each app, turn the Tailscale switch off and on. Each proxy keeps its own copy of the key, so an app only gets the new key when its proxy is created again.