🎉 WireGuard Client App v0.2.10

🚀 What's Changed

🚀 Enhancements & New Features

• Support for Roaming Peers (#60):
  Changed the endpoint configuration schema from str to str?. This highly requested feature makes the peer endpoint fully optional! You can now natively configure devices like mobile phones or laptops with dynamic IP addresses, letting them connect seamlessly to your Home Assistant instance without throwing UI validation errors.
  (Closes issue #60 - Suggested by @rmuk)

📚 Documentation

• Advanced Configuration Examples: Updated DOCS.md with a complete, practical example showing exactly how to structure a roaming peer setup (including how to manually expose a fixed listen-port using post_up).
• Safety Caveats: Appended a warning to README.md's Known Issues to inform users that omitting an endpoint for a standard server-client setup will cause a silent connection failure.

☕ Support this Project

If this add-on has solved issues for you or you'd just like to say thanks, your support helps keep the development active!

Full Changelog: v0.2.9...v0.2.10

🎉 WireGuard Client add-on (or App 🥸) v0.2.9

🚀 What's Changed

🐛 Bug Fixes & Improvements

• Workaround for HIBP check (#58):
  Changed the private_key configuration type from password to str. This prevents the addon from failing to start or save configuration when the Home Assistant Supervisor cannot reach the "Have I Been Pwned" (HIBP) service (due to network issues, firewalls, or outages). This change ensures the addon is robust and reliable even in offline or restricted network environments.
  (Thanks to @negaft for the contribution! in #58)

📚 Documentation

• English Documentation: Translated the WireGuard server setup guide (for add-on testing purpose only!) (wireguard-server/README.md) and script outputs to English for better accessibility.
• Git Security: Updated .gitignore to safely track WireGuard server helper scripts while strictly excluding sensitive configuration files (private keys).

❤️ Acknowledgments

Special thanks to @negaft for identifying the HIBP issue and providing the fix.

Full Changelog: v0.2.8...v0.2.9

🎉 WireGuard Client Add-on v0.2.8 - Critical API Fix and Enhanced Documentation

🙏 Thank You for Your Support!

Your support through Buy Me a Coffee fuels this project! 🍺 Every coffee helps me continue developing new features and improvements. If you find this addon useful, consider supporting the project - it really makes a difference! 💙

🐛 Bug Fixes

• Fixed critical API bug: Resolved double JSON serialization issue where peers field was returned as a string instead of a JSON array. This was causing template errors in Home Assistant sensors (Template variable warning: 'str object' has no attribute 'peer_1'). The API now correctly returns peers as a proper JSON array.

• Fixed Jinja2 templates: Corrected Home Assistant sensor templates to properly access peers[0] instead of peers.peer_1, ensuring compatibility with the array structure.

• Fixed API response format: latest_handshake now correctly returns "Never" (as a string) when no handshake has occurred, instead of an empty string, making template handling more reliable.

🚀 Enhancements

• Enhanced API documentation: Added comprehensive Jinja2 template examples section with practical examples for extracting data from the peers array, including:

  • Accessing first peer data
  • Iterating over all peers
  • Finding specific peers by endpoint
  • Advanced template examples for sensors
  • Human-readable uptime formatting
  • Handshake validation templates

• Improved documentation structure:

  • Added detailed explanation of how value_json works and how Home Assistant links REST responses to templates
  • Added visual flow diagram showing the API request/response cycle
  • Added section on using peers data in other contexts (automations, template sensors)
  • Removed redundancies and improved cross-references between sections
  • Fixed incorrect examples and added proper alternatives

• Documentation links: Added proper GitHub link to API.md from DOCS.md to ensure users can access complete API documentation from Home Assistant's addon documentation interface.

📚 Documentation

• API.md: Complete rewrite and enhancement with:

  • Detailed value_json explanation with step-by-step process
  • Comprehensive Jinja2 template examples for peers array
  • Corrected examples for accessing REST sensor data in different contexts
  • Removed all redundancies and improved clarity
  • Added troubleshooting tips and best practices

• DOCS.md: Added reference to comprehensive API documentation with working GitHub link

Full Changelog: v0.2.7...v0.2.8

🎉 WireGuard Client Add-on v0.2.7 - Improved HTTP server with persistent connections and better performance

🙏 Thank You for Your Support!

Your support through Buy Me a Coffee fuels this project! 🍺 Every coffee helps me continue developing new features and improvements. If you find this addon useful, consider supporting the project - it really makes a difference! 💙

🚀 Enhancements

• Replaced netcat with socat: Improved HTTP server with persistent connections and better performance
• Unified API: Combined status and services into single endpoint on port 51821

Full Changelog: v0.2.6...v0.2.7

🎉 WireGuard Client Add-on v0.2.6 - Enhanced API Release

🙏 Thank You for Your Support!

Your support through Buy Me a Coffee fuels this project! 🍺 Every coffee helps me continue developing new features and improvements. If you find this addon useful, consider supporting the project - it really makes a difference! 💙

I'm excited to announce the release of WireGuard Client Add-on v0.2.6 with major API enhancements and Home Assistant integration improvements!

🆕 What's New

🔧 Enhanced API System

• Dual API Architecture: Separate endpoints for status monitoring and service actions
• Non-standard Ports: Uses ports 51821 (status) and 51822 (services) to avoid conflicts
• Comprehensive Data: Extended status API with traffic statistics, uptime, and peer information

📊 Status API (Port 51821)

• Real-time connection status monitoring
• Traffic statistics (bytes sent/received)
• Peer count and individual peer details
• Uptime and handshake information
• Timestamp data for accurate monitoring

⚡ Services API (Port 51822)

• Reconnect: Restart WireGuard connection
• Restart: Full service restart
• Test: Comprehensive connection validation with interface status and handshake checks

🏠 Home Assistant Integration

• RESTful Sensors: Native integration with Home Assistant's RESTful sensor platform
• Service Commands: Direct control over WireGuard operations
• Automation Ready: Perfect for creating smart VPN automations
• Complete Documentation: Detailed examples and configuration templates

📚 Documentation

• API.md: Complete API documentation with examples
• DOCS.md: Updated with API overview and integration guide

🔗 Quick Start

Basic Sensor Configuration

rest:
  - resource: "http://local-wireguard-client:51821"
    scan_interval: 30
    timeout: 10
    verify_ssl: false
    sensor:
      - name: "WireGuard Status"
        value_template: "{{ value_json.status }}"
        icon: "mdi:vpn"

Service Commands

rest_command:
  wireguard_test:
    url: "http://local-wireguard-client:51822/test"
    method: GET

🎯 Benefits

• Real-time Monitoring: Live updates of WireGuard status and statistics
• Direct Control: Service actions for VPN management
• Automation Ready: Perfect for smart home VPN automations
• Comprehensive Data: Detailed peer information and traffic statistics

📋 Compatibility

• Architectures: aarch64, amd64
• Ports: 51821 (Status API), 51822 (Services API)

📖 Full Documentation

For complete API documentation, automation examples, and advanced configurations, see:

• API.md - Complete API reference
• DOCS.md - Integration guide

🙏 Thanks

Thank you to all contributors and users who provided feedback and suggestions for this release!

Full Changelog: v0.2.5...v0.2.6

What’s changed in Wireguard Client Add-on v0.2.5

🛠 Fixs

fix: resolve wg0 already exists error

• Improve startup/shutdown scripts
• Add automatic interface cleanup
• Update version to 0.2.5

Full Changelog: v0.2.4...v0.2.5

What’s changed in Wireguard Client Add-on v0.2.4

This release focuses on updating core dependencies to ensure compatibility and resolve build issues.

⬆️ Dependency updates

wireguard-tools: Updated from 1.0.20210914-r4 to 1.0.20250521-r0
Base image: Upgraded from 16.3.4 to 18.1.4 for better compatibility

What's Changed

• Clarify how AllowedIPs are used by @holysoles in #42

New Contributors

• @holysoles made their first contribution in #42

Full Changelog: v0.2.3...v0.2.4

What’s changed in Wireguard Client Add-on v0.2.3

🚀 Enhancements

• Comply with the log level setting when logging the current WireGuard … by @jlehtine in #30
• Adds Known issues by @ziriuz84 in #33

⬆️ Dependency updates

• Upgrade wireguard-tools to 1.0.20210914-r4

New Contributors

• @jlehtine made their first contribution in #30
• @ziriuz84 made their first contribution in #33

Full Changelog: v0.2.2...v0.2.3

What’s changed in Wireguard Client Add-on v0.2.2

🛠 Fixs

• Fixed json formatting for api (thanks to @olpal )

What’s changed in Wireguard Client Add-on v0.2.1

🚀 Enhancements

• Add MTU configuration param
• Readme fix