headscale-backup

Back up, restore, and migrate Headscale SQLite databases, configs, and TLS certificates.

40|6|Updated Jul 11, 2026
One-click install
npx skills add https://github.com/magnus919/agent-skills --skill headscale-backup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: headscale-backup
Source: https://github.com/magnus919/agent-skills/tree/main/bundles/tailscale/skills/headscale-backup
Command: npx skills add https://github.com/magnus919/agent-skills --skill headscale-backup

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires sqlite3, tar, rsync, bash, and includes scripts (resource) components.

What problem does it solve?

This skill prevents data loss and simplifies infrastructure management by providing a reliable, automated way to back up and restore the critical state of a Headscale server, including its database, configuration, and TLS assets.

Core Features & Use Cases

  • Safe Live Backups: Uses the SQLite online backup API to create consistent snapshots without stopping the service.
  • Full Lifecycle Support: Includes dedicated workflows for backing up, restoring, and migrating entire Headscale installations between hosts.
  • Use Case: When upgrading your server hardware, use this skill to safely export your entire node registration state, ACL policies, and certificates, then restore them seamlessly on the new host.

Quick Start

Use the headscale-backup skill to create a full backup of the current server state to the default backup directory.

Frequently Asked Questions about headscale-backup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I back up a Headscale SQLite database without stopping the service?

Migrate a Headscale installation to a new server by exporting your SQLite database, configuration files, and TLS certificates, then restoring them seamlessly on the target host using rsync.

What's the best way to migrate Headscale to a new host?

Migrate Headscale to a new host by exporting your SQLite database, configuration files, and TLS certificates, then restoring them seamlessly on the target host using rsync.

Do I need to install special software to back up Headscale?

Backing up Headscale requires only standard Linux utilities, specifically bash, sqlite3, tar, and rsync, to ensure data integrity and system consistency during the backup process.

What files and data are included in a Headscale backup?

A Headscale backup includes the SQLite database, configuration files, and TLS certificates, capturing the critical state needed for disaster recovery and infrastructure management.

Can I restore Headscale from a backup after a hardware failure?

Restore Headscale from a backup after hardware failure by using the dedicated restoration workflow to import your previously saved database, configuration, and TLS assets onto a new host.

Does backing up Headscale require taking the server offline?

Backing up Headscale does not require taking the server offline, as the process uses the SQLite online backup API to safely create live snapshots without stopping the service.