xsteadfastx/dsnet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #31 from axelsimon/update-readme

Browse Source 
Update README, adding more NixOS help and removing ffsend
This commit is contained in:
Callan Bryant 2020-12-05 08:15:57 +00:00 committed by GitHub
commit 8cee8d8672
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -38,8 +38,19 @@ Quick start (AMD64 linux) -- install wireguard, then, after making sure `/usr/lo
Copy the generated configuration file to your device and connect! Copy the generated configuration file to your device and connect!
To send configurations, ffsend (with separately transferred password) or a To send configurations, here are a few suggestions.
local QR code generator may be used. - [ffsend](https://github.com/timvisee/ffsend), the most straightforward option;
- [magic wormhole](https://magic-wormhole.readthedocs.io/), a more advanced
option, where the file never passes through another server;
- [womroleh-william](https://github.com/psanford/wormhole-william), a Go
implementation of the above.
For the above options, one should transfer the password separately.
A local QR code generator, such as the popular
[qrencode](https://fukuchi.org/works/qrencode/) may also be used to generate a
QR code of the configuration. For instance, from the example above:
`qrencode -t ansiutf8 < dsnet-banana.conf`
The peer private key is generated on the server, which is technically not as The peer private key is generated on the server, which is technically not as
secure as generating it on the client peer and then providing the server the secure as generating it on the client peer and then providing the server the
@ -151,10 +162,12 @@ for hugo and PHP code for rendering a similar table.
# Generating other config files # Generating other config files
dsnet currently supports the generation of `wg-quick` configuration by default. dsnet currently supports the generation of a `wg-quick` configuration by
It can also generate VyOS/Vyatta configuration for EdgeOS/Unifi devices such as default. It can also generate VyOS/Vyatta configuration for EdgeOS/Unifi devices
the Edgerouter 4 using the such as the Edgerouter 4 using the
[wireguard-vyatta](https://github.com/WireGuard/wireguard-vyatta-ubnt) package. [wireguard-vyatta](https://github.com/WireGuard/wireguard-vyatta-ubnt) package,
as well as configuration for [NixOS](https://nixos.org), ready to be added to
`configuration.nix` environment definition.
To change the config file format, set the following environment variables: To change the config file format, set the following environment variables:
@ -184,6 +197,31 @@ the interface numbers will (probably) be different. The interface number is
arbitrary, so if it is already assigned replace it with a number of your arbitrary, so if it is already assigned replace it with a number of your
choice. choice.
Example NixOS output:
networking.wireguard.interfaces = {
dsnet = {
ips = [
"10.9.8.2/22"
"fd00:80f8:af4a:4700:aaaa:bbbb:cccc:88ad/64"
];
privateKey = "2PvML6bsmTCK+cBxpV9SfF261fsH6gICixtppfG6KFc=";
peers = [
{
publicKey = "zCDo5yn7Muy3mPBXtarwm5S7JjNKM0IdIdGqoreWmSA=";
presharedKey = "5Fa8Zc8gIkpfBPJUJn5OEVuE00iqmXnS34v4evv1MUM=";
allowedIPs = [
"10.56.72.0/22"
"fd00:80f8:af4a:4700::/64"
];
endpoint = "123.123.123.123:51820";
persistentKeepalive = 25;
}
];
};
};
# FAQ # FAQ
> Does dsnet support IPv6? > Does dsnet support IPv6?