Update docs

master
Thom Dickson 12 months ago
parent 96832b88ca
commit 5f00b6de9e
  1. 42
      docs/wireguard.md

@ -22,9 +22,10 @@ VPN that utilizes state-of-the-art cryptography." Before continuing, let's
break down this statement.
A *Virtual Private Network*, or VPN, is technology that allows a multitude of
computers/servers from all across the world to be tied into a single *private network*
as if they were sitting in the same room. This provides a multitude of both
security advantages and pure networking conveniences for system administrators.
computers/servers from all across the world to be tied into a single *private
network* as if they were sitting in the same room. This provides a multitude of
both security advantages and pure networking conveniences for system
administrators.
WireGuard also claims to use "state-of-the-art cryptography" for security. This
means that data transmitted over a WireGuard network is safe from the prying
@ -43,10 +44,10 @@ Protocol][noise].
### Why Should You Use WireGuard?
WireGuard allows multiple computers/servers to be tied together even when they're not
in the same location. This technology has been increasingly used by the
typical consumer, but its original role of large scale network management
hasn't been forgotten.
WireGuard allows multiple computers/servers to be tied together even when
they're not in the same location. This technology has been increasingly used
by the typical consumer, but its original role of large scale network
management hasn't been forgotten.
By linking servers from around the world over a secure connection, we can
easily pass information between them without having to worry about security of
@ -129,7 +130,7 @@ know how it does all of this. What *is* important is that each of the clients
have to properly identify themselves to the server for the server to route the
traffic.
### The Configuration
### The Configuration (w/ examples)
To set up the above configuration, three key-pairs and configuration files have
to be created.
@ -276,6 +277,25 @@ tunnel.
## FAQ
### Q: What is the advantage of WireGuard over other VPNs (OpenVPN, IPSec)?
WireGuard takes a slightly different approach to networking than some of the
other big VPNs. WireGuard is directly implemented into the Linux kernel these
days, but the best part is the raw speed WireGuard supports.
According to the [WireGuard whitepage][wg-doc], WireGuard has been with nearly
4 times the throughput of OpenVPN, and could respond to pings over 3 times as
fast. The shear speed of WireGuard makes it very desirable in production
environments, while remaining just as (if not more) secure than alternatives.
### Q: Is there an easier way to setup WireGuard?
There are tools out there to help setup WireGuard and manage keys on the various nodes in the network; however, I would recommend getting comfortable setting up a basic network with WireGuard's built in tools.
A quick search on the internet will probably give you some WireGuard
configuration tools, but I can't recommend any as I haven't personally used
them.
## Troubleshooting/ Getting Support
WireGuard is fairly robust and hard to break, but there are a few steps that
@ -303,6 +323,12 @@ If you would like to contribute to this guide, the source is hosted over on the
[NixNet Git][nn-git] server. Open an issue if you think there's
something that needs to be added, changed, or removed.
## Licensing
WireGuard and WireGuard-tools are licensed under the [GPL 2](https://git.zx2c4.com/wireguard-tools/tree/COPYING).
This page is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
[wg-home]: https://www.wireguard.com/
[wg-doc]: https://www.wireguard.com/papers/wireguard.pdf

Loading…
Cancel
Save