README.md

WireGuard implementation for ESPHome

This is an implementation of WireGuard® VPN for ESPHome, based on Wireguard Implementation for ESP-IDF (by @trombik).

Usage

Please refer to the official documentation of WireGuard Component in ESPHome website.

Compatibility

This code targets only ESPHome and has been tested on the following platforms:

• ESP32 (with both frameworks)
• ESP8266
• LibreTiny (with bk72 microcontrollers only)

References

For additional information see:

• the original feature-request esphome/feature-requests#1444
• the first pull-request esphome/esphome#4256
• esp8266 support esphome/esphome#6365
• LibreTiny support droscy/esp_wireguard#4

License

BSD 3-Clause License (SPDX ID: BSD-3-Clause)

This project is licensed under BSD 3-Clause License except where explicitly written in files themselves or when other license files state differently.

"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld. Please see "WireGuard" Trademark Usage Policy for additional information.

Authors

• Simone Rossetto ([email protected])
• Tomoyuki Sakurai ([email protected])
• Daniel Hope ([email protected])
• Kenta Ida ([email protected])
• Matthew Dempsky
• D. J. Bernstein