diff --git a/README.md b/README.md index 06bc4d5c2..7f1f377f0 100644 --- a/README.md +++ b/README.md @@ -939,10 +939,10 @@ SOFTWARE. [vscode-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [vscode-armv7-shield]: https://img.shields.io/badge/armv7-no-red.svg [vscode-i386-shield]: https://img.shields.io/badge/i386-no-red.svg -[addon-tailscale]: https://github.com/hassio-addons/addon-tailscale/tree/8dfacee -[addon-doc-tailscale]: https://github.com/hassio-addons/addon-tailscale/blob/8dfacee/README.md +[addon-tailscale]: https://github.com/hassio-addons/addon-tailscale/tree/f7c0a5e +[addon-doc-tailscale]: https://github.com/hassio-addons/addon-tailscale/blob/f7c0a5e/README.md [tailscale-issue]: https://github.com/hassio-addons/addon-tailscale/issues -[tailscale-version-shield]: https://img.shields.io/badge/version-8dfacee-blue.svg +[tailscale-version-shield]: https://img.shields.io/badge/version-f7c0a5e-blue.svg [tailscale-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [tailscale-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [tailscale-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/tailscale/CHANGELOG.md b/tailscale/CHANGELOG.md index a30093c33..3ebd406ec 100644 --- a/tailscale/CHANGELOG.md +++ b/tailscale/CHANGELOG.md @@ -1,4 +1,8 @@ # Changelog since v0.11.1 +- Enable Tailscale's builtin inbound HTTPS proxy (#137) + +Co-authored-by: Franck Nijhof +- Add docs for accept_dns (#195) - Make accepting magicDNS optional (#194) - Drop userspace networking (#181) - Device limit update in DOCS.md (#192) diff --git a/tailscale/DOCS.md b/tailscale/DOCS.md index b966b33bf..85a869da1 100644 --- a/tailscale/DOCS.md +++ b/tailscale/DOCS.md @@ -55,6 +55,7 @@ Consider disabling key expiry to avoid losing connection to your Home Assistant device. See [Key expiry][tailscale_info_key_expiry] for more information. ```yaml +accept_dns: true advertise_exit_node: true log_level: info login_server: "https://controlplane.tailscale.com" @@ -62,8 +63,21 @@ tags: - tag:example - tag:homeassistant taildrop: true +proxy: true ``` +### Option: `accept_dns` + +If you are experiencing trouble with MagicDNS on this device and wish to +disable, you can do so using this option. + +When not set, this option is enabled by default. + +MagicDNS may cause issues if you run things like Pi-hole or AdGuard Home +on the same machine as this add-on. In such cases disabling `accept_dns` +will help. You can still leverage MagicDNS on other devices on your network, +by adding `100.100.100.100` as a DNS server in your Pi-hole or AdGuard Home. + ### Option: `advertise_exit_node` This option allows you to advertise this Tailscale instance as an exit node. @@ -121,6 +135,49 @@ When not set, this option is enabled by default. Received files are stored in the `/share/taildrop` directory. +### Option: `proxy` + +When not set, this option is enabled by default. + +Tailscale can provide a TLS certificate for your Home Assistant instance within +your tailnet domain. + +This can prevent browsers from warning that HTTP URLs to your Home Assistant instance +look unencrypted (browsers are not aware of the connections between Tailscale +nodes are secured with end-to-end encryption). + +More information: [Enabling HTTPS][tailscale_info_https] + +1. Configure Home Assistant to be accessible through an HTTP connection (this is + the default). See [HTTP integration documentation][http_integration] for more + information. If you still want to use another HTTPS connection to access Home + Assistant, please use a reverse proxy add-on. + +1. Home Assistant, by default, blocks requests from reverse proxies, like the + Tailscale Proxy. To enable it, add the following lines to your + `configuration.yaml`, without changing anything: + + ```yaml + http: + use_x_forwarded_for: true + trusted_proxies: + - 127.0.0.1 + ``` + +1. Navigate to the [DNS page][tailscale_dns] of the admin console: + + - Choose a Tailnet name. + + - Enable MagicDNS if not already enabled. + + - Under HTTPS Certificates section, click Enable HTTPS. + +1. Restart the add-on. + +**Note:** _You should not use any port number in the URL that you used +previously to access Home Assistant. Tailscale Proxy works on the default HTTPS +port 443._ + ## Changelog & Releases This repository keeps a change log using [GitHub's releases][releases] @@ -188,9 +245,12 @@ SOFTWARE. [forum]: https://community.home-assistant.io/?u=frenck [frenck]: https://github.com/frenck [headscale]: https://github.com/juanfont/headscale +[http_integration]: https://www.home-assistant.io/integrations/http/ [issue]: https://github.com/hassio-addons/addon-tailscale/issues [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-tailscale/releases [semver]: https://semver.org/spec/v2.0.0.html [taildrop]: https://tailscale.com/taildrop/ +[tailscale_dns]: https://login.tailscale.com/admin/dns +[tailscale_info_https]: https://tailscale.com/kb/1153/enabling-https/ [tailscale_info_key_expiry]: https://tailscale.com/kb/1028/key-expiry/ diff --git a/tailscale/README.md b/tailscale/README.md index df4760495..44c4dd654 100644 --- a/tailscale/README.md +++ b/tailscale/README.md @@ -48,5 +48,5 @@ If you are more interested in stable releases of our add-ons: [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-8dfacee-blue.svg -[release]: https://github.com/hassio-addons/addon-tailscale/tree/8dfacee \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-f7c0a5e-blue.svg +[release]: https://github.com/hassio-addons/addon-tailscale/tree/f7c0a5e \ No newline at end of file diff --git a/tailscale/config.yaml b/tailscale/config.yaml index 7545b0cfd..fd027d37e 100644 --- a/tailscale/config.yaml +++ b/tailscale/config.yaml @@ -1,5 +1,5 @@ name: Tailscale -version: 8dfacee +version: f7c0a5e slug: tailscale description: Zero config VPN for building secure networks url: https://github.com/hassio-addons/addon-tailscale @@ -33,4 +33,5 @@ schema: tags: - match(^tag:[a-zA-Z0-9]-?[a-zA-Z0-9]+$)? taildrop: bool? + proxy: bool? image: ghcr.io/hassio-addons/tailscale/{arch} diff --git a/tailscale/translations/en.yaml b/tailscale/translations/en.yaml index bf1204270..8a6346d34 100644 --- a/tailscale/translations/en.yaml +++ b/tailscale/translations/en.yaml @@ -35,3 +35,9 @@ configuration: This option allows you to enable Taildrop, a file sharing service that allows you to share files with other Tailscale nodes. When not set, this option is enabled by default. + proxy: + name: Tailscale Proxy + description: >- + This option allows you to enable Tailscale's Proxy feature to present your + Home Assistant instance on your tailnet with a valid certificate. + When not set, this option is enabled by default.