dsnet/README.md

25 lines
1.0 KiB
Markdown
Raw Normal View History

2020-03-02 20:57:52 +01:00
dsnet is a simple tool to manage a wireguard VPN. Think wg-quick but quicker.
2020-03-02 01:48:59 +01:00
2020-03-02 19:15:34 +01:00
Usage: dsnet <cmd>
2020-03-02 01:48:59 +01:00
2020-03-02 19:15:34 +01:00
Available commands:
2020-03-02 01:48:59 +01:00
2020-03-02 19:15:34 +01:00
init : Create /etc/dsnet-config.json containing default configuration + new keys without loading. Edit to taste.
add : Generate configuration for a new peer, adding to /etc/dsnet-config.json. Send with passworded ffsend.
sync : Synchronise wireguard configuration with /etc/dsnet-config.json, creating and activating interface if necessary.
report : Generate a JSON status report to the location configured in /etc/dsnet-config.json.
2020-03-02 01:48:59 +01:00
2020-03-02 19:15:34 +01:00
To remove an interface or bring it down, use standard tools such as iproute2.
To modify or remove peers, edit /etc/dsnet-config.json and then run sync.
2020-03-02 01:48:59 +01:00
2020-02-09 22:02:23 +01:00
2020-03-02 19:15:34 +01:00
To send configurations, ffsend (with separately transferred password) or a local QR code generator may be used.
2020-03-02 20:57:52 +01:00
TODO after first release:
* Hooks for adding routes/ IPtables forwarding rules
* Forward option
* Support for additional subnets in peer config
* Peer endpoint support