Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: Add summary of what this add-on does and doesn't do #314

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+10 −2
Open

Documentation: Add summary of what this add-on does and doesn't do #314

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f23d1da
Add summary of what this add-on does and doesn't do
thijzert May 30, 2024
df56d90
Merge branch 'main' into patch-1
thijzert Jul 17, 2024
a4ad847
Merge branch 'main' into patch-1
thijzert Aug 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions wireguard/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# Home Assistant Community Add-on: WireGuard

[WireGuard®][wireguard] is an extremely simple yet fast and modern VPN that
thijzert marked this conversation as resolved.
Show resolved Hide resolved
utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner,
and more useful than IPsec, while avoiding the massive headache.
utilizes state-of-the-art cryptography. This add-on allows you to use your
Home Assistant add-on as a bridge server, and easily configure and connect
client devices.

**Note**: installing this add-on does not expose the HA interface to connected
WireGuard peers.

## About WireGuard
thijzert marked this conversation as resolved.
Show resolved Hide resolved
WireGuard aims to be faster, simpler, leaner, and more useful than IPsec,
while avoiding the massive headache.

It intends to be considerably more performant than OpenVPN. WireGuard is
designed as a general-purpose VPN for running on embedded interfaces and
Expand Down