diff --git a/README.md b/README.md index 119d6226..3a626182 100644 --- a/README.md +++ b/README.md @@ -375,6 +375,19 @@ Play Spotify music on your Home Assistant device [:books: Spotify Connect add-on documentation][addon-doc-spotify] +### ✓ [Tailscale][addon-tailscale] + +![Latest Version][tailscale-version-shield] +![Supports armhf Architecture][tailscale-armhf-shield] +![Supports armv7 Architecture][tailscale-armv7-shield] +![Supports aarch64 Architecture][tailscale-aarch64-shield] +![Supports amd64 Architecture][tailscale-amd64-shield] +![Supports i386 Architecture][tailscale-i386-shield] + +Zero config VPN for building secure networks + +[:books: Tailscale add-on documentation][addon-doc-tailscale] + ### ✓ [TasmoAdmin][addon-tasmoadmin] ![Latest Version][tasmoadmin-version-shield] @@ -612,6 +625,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: SQLite Web][sqlite-web-issue] - [Open an issue for the add-on: SSH & Web Terminal][ssh-issue] - [Open an issue for the add-on: Spotify Connect][spotify-issue] +- [Open an issue for the add-on: Tailscale][tailscale-issue] - [Open an issue for the add-on: TasmoAdmin][tasmoadmin-issue] - [Open an issue for the add-on: Tautulli][tautulli-issue] - [Open an issue for the add-on: The Lounge][thelounge-issue] @@ -907,6 +921,15 @@ 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/v0.1.0 +[addon-doc-tailscale]: https://github.com/hassio-addons/addon-tailscale/blob/v0.1.0/README.md +[tailscale-issue]: https://github.com/hassio-addons/addon-tailscale/issues +[tailscale-version-shield]: https://img.shields.io/badge/version-v0.1.0-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 +[tailscale-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[tailscale-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-tasmoadmin]: https://github.com/hassio-addons/addon-tasmoadmin/tree/v0.15.1 [addon-doc-tasmoadmin]: https://github.com/hassio-addons/addon-tasmoadmin/blob/v0.15.1/README.md [tasmoadmin-issue]: https://github.com/hassio-addons/addon-tasmoadmin/issues diff --git a/tailscale/CHANGELOG.md b/tailscale/CHANGELOG.md new file mode 100644 index 00000000..fd01c2df --- /dev/null +++ b/tailscale/CHANGELOG.md @@ -0,0 +1,8 @@ +## What’s changed + +First release! 🎉 + +Tailscale is a zero config VPN, which installs on any device in minutes on +any device, including your Home Assistant instance. + +ℹ️ Please note, this add-on is currently in an experimental state. \ No newline at end of file diff --git a/tailscale/DOCS.md b/tailscale/DOCS.md new file mode 100644 index 00000000..050e917c --- /dev/null +++ b/tailscale/DOCS.md @@ -0,0 +1,114 @@ +# Home Assistant Community Add-on: Tailscale + +Tailscale is a zero config VPN, which installs on any device in minutes on +any device, including your Home Assistant instance. + +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 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] +functionality. + +Releases are based on [Semantic Versioning][semver], and use the format +of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented +based on the following: + +- `MAJOR`: Incompatible or major changes. +- `MINOR`: Backwards-compatible new features and enhancements. +- `PATCH`: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2021 Franck Nijhof + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[contributors]: https://github.com/hassio-addons/addon-tailscale/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/?u=frenck +[frenck]: https://github.com/frenck +[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]: http://semver.org/spec/v2.0.0.htm diff --git a/tailscale/README.md b/tailscale/README.md new file mode 100644 index 00000000..5a00a491 --- /dev/null +++ b/tailscale/README.md @@ -0,0 +1,49 @@ +# Home Assistant Community Add-on: Tailscale + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors] + +[![Support Frenck on Patreon][patreon-shield]][patreon] + +Zero config VPN for building secure networks. + +## About + +Tailscale is a zero config VPN, which installs on any device in minutes on +any device, including your Home Assistant instance. + +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. + +## WARNING! THIS IS A BETA VERSION! + +This Home Assistant Add-ons repository contains beta releases of add-ons. + +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. + +If you are more interested in stable releases of our add-ons: + + + +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/?u=frenck +[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png +[github-sponsors]: https://github.com/sponsors/frenck +[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg +[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-v0.1.0-blue.svg +[release]: https://github.com/hassio-addons/addon-tailscale/tree/v0.1.0 \ No newline at end of file diff --git a/tailscale/config.json b/tailscale/config.json new file mode 100644 index 00000000..93fc687a --- /dev/null +++ b/tailscale/config.json @@ -0,0 +1,29 @@ +{ + "name": "Tailscale", + "version": "0.1.0", + "slug": "tailscale", + "description": "Zero config VPN for building secure networks", + "url": "https://github.com/hassio-addons/addon-tailscale", + "ingress": true, + "ingress_port": 0, + "ingress_stream": true, + "startup": "services", + "panel_icon": "mdi:docker", + "arch": [ + "aarch64", + "amd64", + "armhf", + "armv7", + "i386" + ], + "init": false, + "hassio_api": true, + "privileged": [ + "NET_ADMIN" + ], + "devices": [ + "/dev/net/tun" + ], + "host_network": true, + "image": "ghcr.io/hassio-addons/tailscale/{arch}" +} \ No newline at end of file diff --git a/tailscale/icon.png b/tailscale/icon.png new file mode 100644 index 00000000..e723cdb7 Binary files /dev/null and b/tailscale/icon.png differ diff --git a/tailscale/logo.png b/tailscale/logo.png new file mode 100644 index 00000000..ae4da990 Binary files /dev/null and b/tailscale/logo.png differ