selfhosters · Roxedus · Oct 2, 2024 · Oct 1, 2024 · Oct 1, 2024 · Oct 2, 2024
diff --git a/docs/remote/tailscale/advanced.md b/docs/remote/tailscale/advanced.md
@@ -0,0 +1,74 @@
+# Advanced Tailscale Settings
+
+## Log in to Tailscale Settings
+
+1.  Log in to the Unraid server and switch to the **Settings** tab.
+2.  Click on **Tailscale**.
+
+    ![!settings-menu](settings-menu.png)
+
+3.  On the **Tailscale** tab, click the **Viewing** button.
+
+    ![!settings-viewing](settings-viewing.png)
+
+4.  Click **Sign in to confirm identity**
+
+    ![!confirm-identity](confirm-identity.png)
+
+5.  A new window will open. Click **Viewing** in this window, then **Sign in to confirm identity**.
+6.  Log in to Tailscale. Click **Close window** to return to the Tailscale settings once you have logged in.
+
+## Subnet Router
+
+1.  Click **Subnet router**.
+
+    ![!subnet-router](subnet-router.png)
+
+2.  Enter the desired routes and click **Advertise routes**.
+
+    ![!subnet-advertise](subnet-advertise.png)
+
+3.  The routes will be displayed with a **Pending approval** message. The routes must be approved in the Tailscale
+    admin console before they can be used.
+
+    ![!subnet-pending](subnet-pending.png)
+
+4.  Open the [Tailscale admin console](https://login.tailscale.com/admin/machines).
+5.  Locate the server in the machine list. It will have a blue **Subnets** badge with an exclamation point indicating
+    that the server has routes that have not yet been approved.
+
+    ![!subnet-approve](subnet-approve.png)
+
+6.  Click the three dots at the end of the row, then **Edit route settings...**.
+
+    ![!exit-menu](exit-menu.png)
+
+7.  Check the routes to approve and save.
+
+    ![!subnet-routes](subnet-routes.png)
+
+## Exit Node
+
+1.  Click the down arrow under **EXIT NODE**.
+2.  Select **Run as exit node**.
+
+    ![!exit-select](exit-select.png)
+
+3.  The server will now advertise itself as an exit node. This must be approved in the Tailscale admin console before
+    it can be used.
+
+    ![!exit-pending](exit-pending.png)
+
+4.  Open the [Tailscale admin console](https://login.tailscale.com/admin/machines).
+5.  Locate the server in the machine list. It will have a blue **Exit Node** badge with an exclamation point indicating
+    that the server has not yet been approved as an exit node.
+
+    ![!exit-approve](exit-approve.png)
+
+6.  Click the three dots at the end of the row, then **Edit route settings...**.
+
+    ![!exit-menu](exit-menu.png)
+
+7.  Check **Use as exit node** and save.
+
+    ![!exit-routes](exit-routes.png)
diff --git a/docs/remote/tailscale/basic.md b/docs/remote/tailscale/basic.md
@@ -0,0 +1,65 @@
+# Basic Tailscale Setup
+
+These instructions will help you create a Tailnet and connect an Unraid server. Once finished, you should be able to
+connect to the following services via the Tailscale IP / MagicDNS name of the Unraid server:
+
+- WebGUI
+- File shares (SMB/NFS)
+- SSH
+- Bridge mode Docker containers (default or custom bridge networks)
+
+!!! note
+    Docker containers running on ipvlan/macvlan networks (e.g., br0) cannot be accessed via the Tailscale IP for the
+    Unraid server. To connect to these containers, you should either [configure a subnet router](advanced.md) or 
+    [add Tailscale to the container](docker.md).
+
+## Create a Tailnet
+
+1.  Go to [Tailscale](https://www.tailscale.com) and click the **Get Started** button.
+
+    ![!get-started](get-started.png)
+
+2.  Select an identity provider and log in.
+
+    ![!identity-provider](identity-provider.png)
+
+3.  Select either **Business use** or **Personal use**.
+
+    ![!personal-use](personal-use.png)
+
+4.  Follow the provided instructions to install Tailscale on a client device (phone/laptop/etc.).
+
+    ![!first-device](first-device.png)
+
+5.  Once you have installed Tailscale on the device, it will appear on the screen.
+
+    ![!second-device](second-device.png)
+
+## Install the Unraid Tailscale Plugin
+
+1.  Log in to the Unraid server and switch to the **Apps** tab.
+2.  Search for **Tailscale**.
+3.  Install **Tailscale (Plugin)**.
+
+    ![!install-plugin](install-plugin.png)
+
+4.  Click **Done** once the window shows that Tailscale has been installed.
+
+    ![!install-complete](install-complete.png)
+
+5.  Switch to the **Settings** tab, then click on **Tailscale**.
+
+    ![!settings-menu.png](settings-menu.png)
+
+6.  Click **Reauthenticate**.
+
+    ![!reauthenticate](reauthenticate.png)
+
+7.  Click **Connect**.
+
+    ![!connect-device](connect-device.png)
+
+8.  After the connection is complete, the browser will redirect to the Tailscale admin console, which should show both
+    devices are connected.
+
+    ![!tailscale-console](tailscale-console.png)
diff --git a/docs/remote/tailscale/confirm-identity.png b/docs/remote/tailscale/confirm-identity.png
diff --git a/docs/remote/tailscale/connect-device.png b/docs/remote/tailscale/connect-device.png
diff --git a/docs/remote/tailscale/docker.md b/docs/remote/tailscale/docker.md
@@ -0,0 +1,149 @@
+# Directly Connecting Containers to Tailscale
+
+!!! info
+    Docker containers running on bridge networks do not need to have Tailscale installed within the container if the
+    Tailscale plugin is installed. Bridge containers will automatically work on the Unraid server's Tailscale IP.
+
+    Installing Tailscale directly on a container is useful in other scenarios:
+
+    - Containers running on ipvlan/macvlan networks (e.g. br0)
+    - Sharing a specific container via Tailscale.
+
+## Methods
+
+Several options are available to connect a container directly to Tailscale:
+
+- Using the Tailscale Docker Mod for LinuxServer.io containers
+- Running Tailscale as a sidecar container
+
+### Using the Tailscale Docker Mod for LinuxServer.io containers
+
+1.  Edit the Docker container that you wish to connect to Tailscale.
+
+    ![!lsio-add-var](lsio-add-var.png)
+
+2.  Add a variable:
+
+    - Name: **DOCKER_MODS**
+    - Key: **DOCKER_MODS**
+    - Value: `ghcr.io/tailscale-dev/docker-mod:main`
+
+    ![!lsio-docker-mods](lsio-docker-mods.png)
+
+3.  Add a variable:
+
+    - Name: **TAILSCALE_STATE_DIR**
+    - Key: **TAILSCALE_STATE_DIR**
+    - Value: `/var/lib/tailscale`
+
+    ![!lsio-state-var](lsio-state-var.png)
+
+4.  Add a path:
+
+    - Name: **TS_STATE_PATH**
+    - Container Path: `/var/lib/tailscale`
+    - Host Path: A unique name to create a Docker volume for the Tailscale state.
+
+    !!! note
+        You can also use a filesystem path to create a bind mount instead of a Docker volume.
+
+    ![!lsio-state-path](lsio-state-path.png)
+
+5.  Apply the changes to the container.
+
+    !!! warning
+        If the Tailscale state variable or path are not configured, Tailscale will be logged out any time the container
+        restarts.
+
+    !!! tip
+        If you would like to have Tailscale automatically log in instead of using the logs to get a login link, you can
+        create an auth key from the Tailscale admin console and add another variable named `TAILSCALE_AUTHKEY`
+        containing the key.
+
+6.  Open the logs for the container. Locate the line that says **AuthURL is**. Click the link to log in to Tailscale.
+
+    ![!lsio-login](lsio-login.png)
+
+!!! tip
+    The docker mod can be customized further using variables (e.g., to enable Tailscale serve). Refer to the
+    [mod documentation](https://github.com/tailscale-dev/docker-mod/pkgs/container/docker-mod) for the complete list
+    of variables.
+
+### Running Tailscale as a sidecar container
+
+1.  Install **Tailscale-Docker** from Community Applications.
+
+    !!! tip
+        You can create an auth key from the Tailscale admin console and add that as the **Authentication Key** in the
+        container settings. If you do not use an auth key, you will need to open the logs after starting the container
+        to get the login link.
+
+    ![!sidecar-install](sidecar-install.png)
+
+2.  If you did not use an authentication key, open the logs for the created container and use the link to log in.
+
+    !!! warning
+        The container will automatically stop after 60 seconds if the login has not been completed. If using the login
+        link to authenticate, you should start the container, then immediately open the logs and log in to Tailscale.
+
+    ![!sidecar-login](sidecar-login.png)
+
+3.  Edit the container that you wish to connect to Tailscale:
+
+    ??? info "Alternate instructions for Unraid 7.0 beta 2 and earlier"
+        The option to connect container networks was added after Unraid 7 beta 2. On earlier versions of Unraid, you can
+        manually configure the connection:
+
+        - **Network Type**: **None**
+        - **Extra Parameters**: `--net=container:CONTAINERNAME`
+
+    - **Network Type**: **Container** 
+    - **Container Network**: The Tailscale container
+
+    ![!sidecar-connect](sidecar-connect.png)
+
+    ??? note "Published ports"
+        When a container is connected directly to Tailscale, the container ports are used, not the published ports.
+
+        For example, for a container with these ports:
+
+        ![!sidecar-ports](sidecar-ports.png)
+
+        The service would become available on **http://server.tailnet.ts.net/** (using port 80) and 
+        **https://server.tailnet.ts.net/** (using port 443). Ports 7080 and 7443 are not used.
+
+        If you wish to publish ports on a local address in addition to the Tailscale address, you must add the ports
+        to the settings for the Tailscale container.
+
+        ![!sidecar-ts-ports](sidecar-ts-ports.png)
+
+#### Enable Kernel Networking
+
+!!! info
+    Userspace networking (the default) is fine for most scenarios (e.g., allowing container to be accessed via
+    Tailscale).
+
+    Enabling kernel networking may be required in scenarios where the container must be able to make MagicDNS
+    queries or initiate connections to other Tailscale devices, for example:
+
+     - A backup container that either ***pulls data from*** or ***pushes data to*** another system via Tailscale.
+       (Backup containers where clients push data to the container via Tailscale do not require kernel networking.)
+     - A monitoring container that connects to other systems via Tailscale to monitor system status (e.g., Uptime Kuma)
+
+1.  Edit the Tailscale container.
+2.  Set **Privileged** to **On**.
+
+    ![!sidecar-kernel-privileged](sidecar-kernel-privileged.png)
+
+3.  Expand the settings, then set **TS_USERSPACE** to `false`.
+
+    ![!sidecar-kernel-userspace](sidecar-kernel-userspace.png)
+
+4.  Add a device:
+
+    - **Name**: `/dev/net/tun`
+    - **Value**: `/dev/net/tun`
+
+    ![!sidecar-kernel-tun](sidecar-kernel-tun.png)
+
+5.  Apply the changes.
diff --git a/docs/remote/tailscale/exit-approve.png b/docs/remote/tailscale/exit-approve.png
diff --git a/docs/remote/tailscale/exit-menu.png b/docs/remote/tailscale/exit-menu.png
diff --git a/docs/remote/tailscale/exit-pending.png b/docs/remote/tailscale/exit-pending.png
diff --git a/docs/remote/tailscale/exit-routes.png b/docs/remote/tailscale/exit-routes.png
diff --git a/docs/remote/tailscale/exit-select.png b/docs/remote/tailscale/exit-select.png
diff --git a/docs/remote/tailscale/first-device.png b/docs/remote/tailscale/first-device.png
diff --git a/docs/remote/tailscale/get-started.png b/docs/remote/tailscale/get-started.png
diff --git a/docs/remote/tailscale/identity-provider.png b/docs/remote/tailscale/identity-provider.png
diff --git a/docs/remote/tailscale/install-complete.png b/docs/remote/tailscale/install-complete.png
diff --git a/docs/remote/tailscale/install-plugin.png b/docs/remote/tailscale/install-plugin.png
diff --git a/docs/remote/tailscale/lsio-add-var.png b/docs/remote/tailscale/lsio-add-var.png
diff --git a/docs/remote/tailscale/lsio-docker-mods.png b/docs/remote/tailscale/lsio-docker-mods.png
diff --git a/docs/remote/tailscale/lsio-login.png b/docs/remote/tailscale/lsio-login.png
diff --git a/docs/remote/tailscale/lsio-state-path.png b/docs/remote/tailscale/lsio-state-path.png
diff --git a/docs/remote/tailscale/lsio-state-var.png b/docs/remote/tailscale/lsio-state-var.png
diff --git a/docs/remote/tailscale/personal-use.png b/docs/remote/tailscale/personal-use.png
diff --git a/docs/remote/tailscale/reauthenticate.png b/docs/remote/tailscale/reauthenticate.png
diff --git a/docs/remote/tailscale/second-device.png b/docs/remote/tailscale/second-device.png
diff --git a/docs/remote/tailscale/settings-menu.png b/docs/remote/tailscale/settings-menu.png
diff --git a/docs/remote/tailscale/settings-viewing.png b/docs/remote/tailscale/settings-viewing.png
diff --git a/docs/remote/tailscale/sidecar-connect.png b/docs/remote/tailscale/sidecar-connect.png
diff --git a/docs/remote/tailscale/sidecar-install.png b/docs/remote/tailscale/sidecar-install.png
diff --git a/docs/remote/tailscale/sidecar-kernel-privileged.png b/docs/remote/tailscale/sidecar-kernel-privileged.png
diff --git a/docs/remote/tailscale/sidecar-kernel-tun.png b/docs/remote/tailscale/sidecar-kernel-tun.png
diff --git a/docs/remote/tailscale/sidecar-kernel-userspace.png b/docs/remote/tailscale/sidecar-kernel-userspace.png
diff --git a/docs/remote/tailscale/sidecar-login.png b/docs/remote/tailscale/sidecar-login.png
diff --git a/docs/remote/tailscale/sidecar-ports.png b/docs/remote/tailscale/sidecar-ports.png
diff --git a/docs/remote/tailscale/sidecar-ts-ports.png b/docs/remote/tailscale/sidecar-ts-ports.png
diff --git a/docs/remote/tailscale/subnet-advertise.png b/docs/remote/tailscale/subnet-advertise.png
diff --git a/docs/remote/tailscale/subnet-approve.png b/docs/remote/tailscale/subnet-approve.png
diff --git a/docs/remote/tailscale/subnet-pending.png b/docs/remote/tailscale/subnet-pending.png
diff --git a/docs/remote/tailscale/subnet-router.png b/docs/remote/tailscale/subnet-router.png
diff --git a/docs/remote/tailscale/subnet-routes.png b/docs/remote/tailscale/subnet-routes.png
diff --git a/docs/remote/tailscale/tailscale-console.png b/docs/remote/tailscale/tailscale-console.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -78,3 +78,8 @@ nav:
       - VPN:
           - Route a container trough a VPN with PfSense: docker/pfsense_vlan_vpn/pfsense_vlan_vpn.md
       - Writing a template compatible for Unraid: docker/templating/templating.md
+  - Remote Access:
+      - Tailscale:
+          - Basic Setup: remote/tailscale/basic.md
+          - Advanced Settings: remote/tailscale/advanced.md
+          - Docker Containers: remote/tailscale/docker.md