Files

StevenMcElligott ec92933802 docs(Tailscale): Add Instructions for Host-Network (#11756 )

**Description**

Add description on enabling `Host-Networking`

⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

2023-08-25 10:19:49 +02:00

4.0 KiB

Raw Blame History

How-To

This is a quick how-to or setup-guide to use Tailscale using on your TrueNAS box. This can be applied to other systems but this specific guide is SCALE specific with the prerequisites.

:::caution

This guide doesn't cover using Tailscale with individual applications. While there are methods to use Tailscale (as an app) with other individual apps this requires Host-Networking and beyond the scope of this guide and may not work for all apps. The suggested use in the future will be the Tailscale Add-On

:::

Requirements

Tailscale Account (Free accounts available at Tailscale's Official website)
Tailscale Truecharts Chart

Prerequisites (LAN access only)

For proper access to your local network (LAN), this chart requires two sysctl values set on your TrueNAS or system. For TrueNAS SCALE the way to change these values are inside System Settings then Advanced. On that screen you add the following two values:

net.ipv4.ip_forward
net.ipv4.conf.all.src_valid_mark

Set them to 1 and Enabled

Also prepare your Tailscale Auth Key for your setup, easy to generate on the page below

Tailscale Chart Setup

Application name

Ideally use tailscale but you can use any name here.

Global Pod Options

This section is hidden by default for TrueNAS SCALE but if you wish to use Host-Networking or create an interface inside TrueNAS SCALE (tailscale0)

Click Expert - Pod Options
Click the checkbox for Host-Networking if it isn't enabled

App Configuration

Auth Key: The key you received from tailscale in prerequisites above
Userspace: Now enabled by default, as it is required when using local routes and as an exit node (see below). Userspace restricts clients to only accessing the GUI and Samba. This needs to be unchecked if you need to give Tailscale full access to all the features inside TrueNAS SCALE (not just GUI/SMB, but RSYNC, PING and directly connect to other Tailscale IPs, etc). More info in the Tailscale Userspace Guide.
Accept DNS: Enabling it will pass your Global Nameservers from Tailscale to your local install.
Routes: Change to the routes you wish Tailscale to have access to on the devices it's connected, such as my LAN in the example. Required if you want to access APPS over Tailscale using TrueNASIP:Port from any Tailscale connected client.
Extra Args passes arguments/flags to the tailscale up command.
Hostname You can specify a specific hostname for use inside Tailscale (see image below). (Passes --hostname HOSTNAME to Extra args)
Advertise as exit node This is used to pass traffic through tailscale like a private VPN. (Passes --advertise-exit-node to Extra args)

For more Extra Args and their usage please check the Tailscale Knowledge Base since we consider these advanced features and these may/not be compatible with everyone's exact setup.

TODO: Update image with the new fields

Hostname example

Networking and Services

The default ports are fine for this chart, you shouldn't need to port forward or open ports on your router.

Storage and Persistence

Highly recommended to leave it as PVC (Simple)

Ingress

Shouldn't need to enable this.

Security and Permissions

Should be left as is, unless you know what you are doing!

Resources and Devices

You can set custom resources for CPU/RAM, but defaults should be work fine in most cases Defaults are 4 vCores and 8G RAM.

Addons

Shouldn't need to enable any.

Support

You can also reach us using Discord for real-time feedback and support
If you found a bug in our chart, open a Github issue

4.0 KiB Raw Blame History