Skip to content

lmagyar/homeassistant-addon-tailscale

 
 

Repository files navigation

Home Assistant Custom App: Tailscale with features

Zero config VPN for building secure networks.

Warning

This is a fork of the community app!

Changes:

  • Release unreleased changes from community app
    • Fix MagicDNS: In case of invalid networking DNS settings disable MagicDNS to enable the app to start up
    • Fix MagicDNS: Move MagicDNS egress and ingress proxies to non-default ports, refactor to support appconnectors also
    • Support Supervised installations
    • Fix forwarding for local tailnet connections
    • Force reauthentication when Tailscale explicitly complains about login server change
  • Release pending changes from community app
    • 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
  • Release unmerged changes from community app
    • Make Tailscale SSH configurable
    • Make ha cli available in Tailscale SSH sessions (within bash shell with banner and completion)
    • Create persistent notification also (not just log warning) when key expiration or invalid networking DNS settings are detected
    • Optionally copy Tailscale Serve's certificate files to /ssl folder
    • Make DSCP configurable on tailscaled's network traffic
    • Configure log format for the app to be compatible with Tailscale's format

One-click migration from the community app to this fork:

  • Install the Advanced SSH & Web Terminal app and disable it's protection mode
  • Please create a complete system backup before executing this script!
  • 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 app, then start the forked version.
  • With copying the app internal state, the new forked app 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 app will jump into it's place.
  • And even if you executed previously some tailscale configuration inside the app's container, those settings will be also migrated with the internal state.
Migration log (from the community app to this fork)

Warning

GitHub Release Last Updated Reported Installations Project Stage License

Supports aarch64 Architecture Supports amd64 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. In Home Assistant, go to Settings -> Apps -> Install app.
  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" app and click it. If it doesn't show up, wait until HA refreshes the information about the app, 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 app's Documentation pages.

Contributors

Languages

  • Shell 81.2%
  • Dockerfile 15.1%
  • Groovy 3.7%