Skip to content

lmagyar/homeassistant-addon-tailscale

 
 

Repository files navigation

Home Assistant Custom Add-on: Tailscale with features

Zero config VPN for building secure networks.

Warning

This is a fork of the community add-on!

Changes:

  • Release unreleased changes from community add-on
    • Update tailscale/tailscale to v1.92.5
    • Make exit-node configurable
  • Release pending changes from community add-on
    • Make all config options mandatory, fill in the default values for previously optional config options
    • Make accept_routes, advertise_connector, advertise_exit_node, advertise_routes, taildrop and userspace_networking options default disabled to align with stock Tailscale's platform-specific behavior
    • Rename tags option to advertise_tags to align with stock Tailscale's naming convention - config is automatically updated
    • Add support for Taildrive
    • Fix MagicDNS incompatibility with Home Assistant
    • Make always use derp option configurable
    • Create persistent notification also (not just log warning) when key expiration is detected
  • Withhold changes from community add-on (will be released here later)
    • Drop support for armv7 architecture
    • Update Add-on base image to v19 (drop armv7 support)
  • Release unmerged changes from community add-on
    • Make Tailscale SSH configurable
    • Optionally copy Tailscale Serve's certificate files to /ssl folder
    • Make DSCP configurable on tailscaled's network traffic
    • Configure log format for the add-on to be compatible with Tailscale's format

One-click migration from the community add-on to this fork:

  • Install the Advanced SSH & Web Terminal add-on
  • From the cli execute: curl -s -o /tmp/migrate_from_community_add_on https://raw.githubusercontent.com/lmagyar/homeassistant-addon-tailscale/refs/heads/main/scripts/migrate_from_community_add_on && bashio /tmp/migrate_from_community_add_on

Note:

  • This will install the forked version (if not already installed), backup and stop the community version, copy and update the configuration, and (this is the big thing) will also copy the internal state of the add-on, then start the forked version.
  • With copying the add-on internal state, the new forked add-on will start up with the exact same state, ie. with the same tailnet authentication also. So do not remove the current device from Tailscale's admin page, the forked add-on will jump into it's place.
  • And even if you executed previously some tailscale configuration inside the add-ons container, those settings will be also migrated with the internal state.
  • But copying the add-on's internal state requires executing bash and python scripts inside the Supervisor's container! Executing python scripts requires installing gdb and pyrasite inside the Supervisor's container (they will be uninstalled by the script also). So please create a complete system backup before executing this script!

Warning

GitHub Release Last Updated Reported Installations Project Stage License

Supports aarch64 Architecture Supports amd64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture

Github Actions Project Maintenance GitHub Activity

About

Tailscale is a zero config VPN, which installs on any device in minutes, 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.

Installation

  1. Navigate in your Home Assistant frontend to Settings -> Add-ons -> Add-on Store.
  2. In the ... menu at the top right corner click Repositories, add https://github.com/lmagyar/homeassistant-addon-tailscale as repository.
  3. Find the "Tailscale with features" add-on and click it. If it doesn't show up, wait until HA refreshes the information about the add-on, or click Check for updates in the ... menu at the top right corner.
  4. Click the "INSTALL" button.

Documentation

For more details, please see the add-on's Documentation pages.

Languages

  • Shell 78.5%
  • Dockerfile 16.7%
  • Groovy 4.8%