diff --git a/README.md b/README.md index 5a9954046..261f56ccc 100644 --- a/README.md +++ b/README.md @@ -944,10 +944,10 @@ SOFTWARE. [spotify-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [spotify-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [spotify-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-tailscale]: https://github.com/hassio-addons/addon-tailscale/tree/5289379 -[addon-doc-tailscale]: https://github.com/hassio-addons/addon-tailscale/blob/5289379/README.md +[addon-tailscale]: https://github.com/hassio-addons/addon-tailscale/tree/1ac4c2b +[addon-doc-tailscale]: https://github.com/hassio-addons/addon-tailscale/blob/1ac4c2b/README.md [tailscale-issue]: https://github.com/hassio-addons/addon-tailscale/issues -[tailscale-version-shield]: https://img.shields.io/badge/version-5289379-blue.svg +[tailscale-version-shield]: https://img.shields.io/badge/version-1ac4c2b-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 d481cd9f2..270f73395 100644 --- a/tailscale/CHANGELOG.md +++ b/tailscale/CHANGELOG.md @@ -1 +1 @@ -- ✨ Initial Tailscale add-on code (#1) +- 📚Add Tailscale account instructions to documentation (#3) diff --git a/tailscale/DOCS.md b/tailscale/DOCS.md index a1d5c836d..050e917ce 100644 --- a/tailscale/DOCS.md +++ b/tailscale/DOCS.md @@ -1,7 +1,5 @@ # Home Assistant Community Add-on: Tailscale -Zero config VPN for building secure networks. - Tailscale is a zero config VPN, which installs on any device in minutes on any device, including your Home Assistant instance. @@ -9,19 +7,43 @@ Create a secure network between your servers, computers, and cloud instances. Even when separated by firewalls or subnets, Tailscale just works. Tailscale manages firewall rules for you, and works from anywhere you are. +## Prerequisites + +In order to use this add-on, you'll need a Tailscale account. + +It is free to use for personal & hobby projects, up to 20 clients/devices on a +single user account. Sign up using your Google, Microsoft or GitHub account at +the following URL: + + + +You can also create an account during the add-on installation processes, +however, it is nice to know where you need to go later on. + ## Installation 1. Search for the "Tailscale" add-on in the Supervisor add-on store and install it. 1. Start the "Tailscale" add-on. 1. Check the logs of the "Tailscale" add-on to see if everything went well. -1. Open the Web UI of the "Tailscale" add-on to complete authentication. +1. Open the Web UI of the "Tailscale" add-on to complete authentication and + couple your Home Assistant instance with your Tailscale account. 1. Done! ## Configuration This add-on has no additional configuration options for the add-on itself. +However, when logging in to Tailscale, you can configure your Tailscale +network right from their interface. + + + +The add-on exposes "Exit Node" capabilities that you can enable from your +Tailscale account. Additionally, if the Supervisor managed your network ( +which is the default), the add-on will also advertise routes to your +subnet to Tailscale. + ## Changelog & Releases This repository keeps a change log using [GitHub's releases][releases] diff --git a/tailscale/README.md b/tailscale/README.md index 17ef4be57..a70e5d0a0 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-5289379-blue.svg -[release]: https://github.com/hassio-addons/addon-tailscale/tree/5289379 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-1ac4c2b-blue.svg +[release]: https://github.com/hassio-addons/addon-tailscale/tree/1ac4c2b \ No newline at end of file diff --git a/tailscale/config.json b/tailscale/config.json index a71098f1a..d10902367 100644 --- a/tailscale/config.json +++ b/tailscale/config.json @@ -1,6 +1,6 @@ { "name": "Tailscale", - "version": "5289379", + "version": "1ac4c2b", "slug": "tailscale", "description": "Zero config VPN for building secure networks", "url": "https://github.com/hassio-addons/addon-tailscale",