界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
效率与协作 · SKILL.md

headscale-routing

headscale-routing

【效率与协作】Configure subnet routers and exit nodes in a Headscale tailnet to extend mesh access to non-Tailscale devices and route internet traffic. Use when setting up subnet routing for LAN devices or configuring exit nodes for privacy.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: headscale-routing description: Configure subnet routers and exit nodes in a Headscale tailnet to extend mesh access to non-Tailscale devices and route internet traffic. Use when setting up subnet routing for LAN devices or configuring exit nodes for privacy. metadata: category: devops

headscale-routing

Overview

Subnet routers extend a tailnet to non-Tailscale devices (printers, NAS boxes, IoT devices) by advertising the local LAN subnet routes through a gateway node. Exit nodes route all non-tailnet internet traffic through a home server, providing privacy on untrusted networks (coffee shop Wi-Fi, hotel networks, etc.).

Headscale manages route approval centrally — routes must be advertised by the gateway node and then approved on the Headscale server before they become active.

Subnet Router Setup

  1. On the gateway node, advertise the LAN subnet:
    tailscale up --advertise-routes=192.168.1.0/24
    
  2. On the Headscale server, approve the route:
    headscale routes approve -r <route-id>
    
  3. On client nodes that need to reach the subnet, enable route acceptance:
    tailscale up --accept-routes
    

Exit Node Setup

  1. On the exit node, advertise it as an exit node:
    tailscale up --advertise-exit-node
    
  2. On the Headscale server, approve the exit node route.
  3. On the client, select the exit node:
    tailscale set --exit-node=<node-name>
    

Auto-Approvers

Configure Headscale ACL policy to auto-approve routes from trusted nodes:

{
  "autoApprovers": {
    "routes": {
      "192.168.0.0/16": ["tag:gateway"]
    },
    "exitNode": ["tag:gateway"]
  }
}

Nodes carrying tag:gateway will have their advertised routes or exit-node status approved automatically without manual intervention.

Via Filtering

Use grants.via in ACL policies to restrict cross-subnet access:

{
  "grants": [
    {
      "src": ["tag:monitoring"],
      "dst": ["tag:servers"],
      "app": ["prometheus"],
      "via": ["192.168.10.0/24"]
    }
  ]
}

This ensures traffic from monitoring nodes to servers is routed through the specified subnet, enabling firewall policies on the gateway to inspect or filter traffic.

SNAT on Subnet Routers

By default, Headscale enables Source NAT (SNAT) on subnet router traffic. This means traffic originating from tailnet clients destined for the advertised subnet appears to come from the gateway node's IP. To disable SNAT:

tailscale up --advertise-routes=192.168.1.0/24 --snat-subnet-routes=false

Disable SNAT when the downstream network needs to see the original client IP for logging, ACLs, or per-device firewall rules.

List / Approve / Reject Routes on Headscale

# List all routes with status
headscale routes list

# Approve a specific route
headscale routes approve -r <route-id>

# Approve all routes from a node
headscale routes approve --all -n <node-name>

# Reject a route
headscale routes reject -r <route-id>

Gotchas

  • Stable gateway required: Subnet routes need a gateway node that stays online. If the gateway goes down, the route becomes unavailable.
  • --accept-routes on clients: Clients will NOT use advertised subnet routes unless they themselves run with --accept-routes or have it in their up flags.
  • IPv4-only by default: Tailscale subnet routing is IPv4-only unless you explicitly configure dual-stack (IPv4 + IPv6).
  • Overlapping subnets: If two nodes advertise overlapping subnets, routing behavior is undefined. Use distinct, non-overlapping CIDRs.
  • Headscale API required for scripting: The headscale routes CLI commands above require shell access to the Headscale server. For remote management, use the Headscale REST API with $HEADSCALE_URL and $HEADSCALE_API_KEY.

Environment

VariableDescription
HEADSCALE_URLHeadscale server URL
HEADSCALE_API_KEYAPI key from headscale apikeys create

Trigger Conditions

  • "subnet router"
  • "exit node"
  • "advertise route"
  • "approve route"
  • "route traffic"
  • "subnet routing"
  • "exit node setup"

Scripts

Refer to individual script help (--help) for usage details:

ScriptDescription
hs-advertise-routes.shAdvertise subnet routes on a Tailscale node
hs-approve-routes.shList and approve/reject routes on Headscale
hs-list-routes.shList all routes with detailed status

When not to use

Do not use this skill for node lifecycle management (load headscale-node-lifecycle instead) or for writing ACL policies (load tailnet-policy). It covers subnet routers and exit nodes only.

我的收藏