chore(tailscale): update docs a bit (#3732)

* chore(tailscale): update docs a bit * whops * toLower
2022-09-10 15:57:18 +03:00
parent 88413ad80a
commit db1ee5ed73
3 changed files with 79 additions and 46 deletions
@@ -20,7 +20,7 @@ sources:
  - https://github.com/truecharts/charts/tree/master/charts/stable/tailscale
  - https://hub.docker.com/r/tailscale/tailscale
  - https://github.com/tailscale/tailscale/blob/main/docs/k8s/run.sh
-version: 1.0.7
+version: 1.0.8
 annotations:
  truecharts.org/catagories: |
    - network
@@ -27,38 +27,71 @@ Also prepare your Tailscale Auth Key for your setup, easy to generate on the pag

 ## Tailscale Chart Setup

-Step 1-2: Ideally use `tailscale` but you can use any name here and leave defaults for Step 2
+### Application name

-Step 3:
+Ideally use `tailscale` but you can use any name here.

- Enter `Auth Key` you received from tailscale in prerequisites above
- Keep `Userspace` checked (default) unless you wish to create your own Wireguard tunnels,
- The default for `Accept DNS` is unchecked but enabling it will pass your Global Nameservers from Tailscale to your local install
- Change `Routes` to the routes you wish Tailscale to have access to on the devices it's connected, such as my LAN in the example
+### Controller
+
+Leave defaults here.
+
+### Container Configuration
+
+- `Auth Key`: The key you received from tailscale in prerequisites above
+- `Userspace`: Keep checked (default) unless you wish to create your own tunnels.
+- `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.
 - `Extra Args` passes arguments/flags to the `tailscale up` command.

-  Common flags/arguments:
+Common flags/arguments:

-  - `--advertise-exit-node`
-    This is used to pass traffic through tailscale like a private VPN.
-  - `--hostname=<name>`
-    You can specify a specific hostname for use inside Tailscale (see image below).
+- `--advertise-exit-node`
+  This is used to pass traffic through tailscale like a private VPN.
+- `--hostname=<name>`
+  You can specify a specific hostname for use inside Tailscale (see image below).

 For more Extra Args and their usage please check the [Tailscale Knowledge Base](https://tailscale.com/kb/1080/cli/#up)
 since we consider these advanced features and these may/not be compatible with everyone's exact setup.

 ![tailscale-step-3](img/How-To-Image-2.png)

-Hostname example
+**Hostname example**
+
 ![hostname-example](img/Hostname.png)

-Step 4:
+### Networking and Services

- The default ports are fine for this chart, you shouldn't need to port forward or open ports on your router. However many people will want to access their SMB shares or TrueNAS GUI via Tailscale. In order to do so you will have to ensure the screen is setup as below.
+The default ports are fine for this chart, you shouldn't need to port forward or open ports on your router.
+
+:::caution
+
+In case you want to access their SMB shares or TrueNAS GUI via Tailscale.
+You will have to ensure that `Host Networking` is enabled.
+
+:::

 ![tailscale-step-4](img/How-To-Image-3.png)

-Steps 5-9: Adjust as necessary but defaults are fine.
+### 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

@@ -1,21 +1,21 @@
 version: "0.2"
 words:
-  - ADLIST
+  - adlist
  - airsonic
  - akadmin
  - aliasgroup
  - allowtransparency
-  - APITOKEN
+  - apitoken
  - appname
  - appnamehere
-  - AUDITLOG
-  - Authentik
-  - Authexample
+  - auditlog
+  - authentik
+  - authexample
  - authkey
  - authtoken
  - autoconnect
  - autoplay
-  - AUTOSYNC
+  - autosync
  - backupname
  - basicauthexample
  - bazarr
@@ -24,9 +24,9 @@ words:
  - cacher
  - chainname
  - cheatsheet
-  - Chronos
+  - chronos
  - cloudflared
-  - Cloudflareddns
+  - cloudflareddns
  - collabora
  - configfile
  - configmap
@@ -36,26 +36,26 @@ words:
  - dbcreds
  - dbengine
  - ddns
-  - Djava
-  - DNAT
+  - djava
+  - dnat
  - dockerized
  - duplicati
  - dynmap
-  - Entrypoints
+  - entrypoints
  - eptgmk
-  - Fireshare
-  - FLUSHTABLES
+  - fireshare
+  - flushtables
  - fullname
  - geoip
  - geoipupdate
  - gibibyte
  - gluster
  - goauthentik
-  - GUNICORN
+  - gunicorn
  - healthcheck
  - healthchecks
  - hexo
-  - HONEYBADGER
+  - honeybadger
  - hostpath
  - hyperconverged
  - hyperthread
@@ -89,13 +89,13 @@ words:
  - letsencrypt
  - lidarr
  - loadbalancer
-  - LOCALCNAMERECORDS
-  - LOCALDNSRECORDS
+  - localcnamerecords
+  - localdnsrecords
  - localdomain
  - logfile
  - loolwsd
  - mailenabled
-  - Mailgun
+  - mailgun
  - mariadbcreds
  - mattwebbio
  - maxmind
@@ -104,7 +104,7 @@ words:
  - metallb
  - middlewares
  - middlewaretcps
-  - Mikrotik
+  - mikrotik
  - milicpu
  - minecraft
  - minio
@@ -121,11 +121,11 @@ words:
  - nocaptcha
  - nodeport
  - nodeports
-  - NOHARDLINKS
+  - nohardlinks
  - notebookbar
  - ornias
  - ovpn
-  - PASSWRD
+  - passwrd
  - pgid
  - photoprism
  - pihole
@@ -134,7 +134,7 @@ words:
  - plex
  - preconfigured
  - prefs
-  - Preload
+  - preload
  - proto
  - proxyhttp
  - proxyhttps
@@ -151,10 +151,10 @@ words:
  - rcon
  - rcontcp
  - recaptha
-  - RECORDTYPES
-  - Recyclarr
+  - recordtypes
+  - recyclarr
  - rediscreds
-  - REGEXLIST
+  - regexlist
  - registeringats
  - reneg
  - replacementurlhere
@@ -162,17 +162,17 @@ words:
  - sabnzbd
  - schouten
  - selfsigned
-  - SERVERCONFIG
+  - serverconfig
  - serverstransports
  - serviceexpert
  - smallblock
  - sonarr
  - sonarrsabnzbd
-  - Sonatype
+  - sonatype
  - srcsets
  - ssvnc
  - statefulset
-  - STATICDHCPLEASES
+  - staticdhcpleases
  - staticfiles
  - steamcommunica
  - steammasterser
@@ -193,7 +193,7 @@ words:
  - tlsstores
  - traefik
  - traefikservices
-  - Trakt
+  - trakt
  - truecharts
  - truenas
  - truetool
@@ -212,5 +212,5 @@ words:
  - wger
  - whisparr
  - xsystems
-  - ZEROTIER
+  - zerotier
  - zwavejs