wireguard-config

Generate and update WireGuard wg0.conf from config.yaml for Home Assistant.

Updated Feb 7, 2026
One-click install
npx skills add https://github.com/JSchmid6/ha-wireguard-client-addon --skill wireguard-config
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wireguard-config
Source: https://github.com/JSchmid6/ha-wireguard-client-addon/tree/main/.github/skills/wireguard-config
Command: npx skills add https://github.com/JSchmid6/ha-wireguard-client-addon --skill wireguard-config

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate or modify WireGuard VPN client configuration for the Home Assistant add-on. Use when adding new WireGuard options, changing the config schema, or updating how the wg0.conf is generated in run.sh.

Core Features & Use Cases

  • End-to-end configuration: Aligns config.yaml schema, run.sh input parsing, and wg0.conf generation.
  • Safe evolution: Add new options with validation and clear documentation to minimize downtime.
  • Practical workflow: When peers, options, or routing needs change, Recompute wg0.conf automatically during startup.

Quick Start

Configure a new option in config.yaml and run the add-on to regenerate wg0.conf.

Frequently Asked Questions about wireguard-config

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

FAQPage Schema
How do I generate a WireGuard config for the Home Assistant add-on?

To generate a WireGuard config for Home Assistant, define your VPN options in config.yaml and run the add-on to automatically render a correct wg0.conf file with proper permissions during startup.

Can I add new WireGuard options to the config.yaml schema without breaking routing?

Yes, you can add new WireGuard options to the config.yaml schema. The generation process validates new fields and aligns run.sh input parsing to ensure your wg0.conf renders correctly with minimal downtime.

What's the best way to update WireGuard peers in Home Assistant?

The best way to update WireGuard peers in Home Assistant is to modify the peer definitions in config.yaml, which triggers automatic recomputation of wg0.conf during add-on startup.

How does wg0.conf generation work during the Home Assistant add-on startup?

wg0.conf generation works by reading config.yaml, validating the configured fields, and rendering the WireGuard configuration file with proper permissions when the add-on run.sh script executes.

Do I need to manually edit wg0.conf when changing VPN routing in Home Assistant?

No, you do not need to manually edit wg0.conf. When routing needs change, update config.yaml and the add-on automatically regenerates the WireGuard configuration during startup.