update README
This commit is contained in:
parent
319e238261
commit
1fd9e03509
29
README.md
29
README.md
@ -5,21 +5,32 @@ but quicker.
|
|||||||
|
|
||||||
Available commands:
|
Available commands:
|
||||||
|
|
||||||
init : Create /etc/dsnet-config.json containing default configuration + new keys without loading. Edit to taste.
|
init : Create /etc/dsnetconfig.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.
|
add : Add a new peer + sync
|
||||||
sync : Synchronise wireguard configuration with /etc/dsnet-config.json, creating and activating interface if necessary.
|
up : Create the interface, run pre/post up, sync
|
||||||
report : Generate a JSON status report to the location configured in /etc/dsnet-config.json.
|
report : Generate a JSON status report to the location configured in /etc/dsnetconfig.json.
|
||||||
|
remove : Remove a peer by hostname provided as argument + sync
|
||||||
|
down : Destroy the interface, run pre/post down
|
||||||
|
sync : Update wireguard configuration from /etc/dsnetconfig.json after validating
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Dsnet assumes a DNS server is running on the server.
|
Quick start -- install wireguard and dsnet, then:
|
||||||
|
|
||||||
|
sudo dsnet init
|
||||||
|
sudo dsnet up
|
||||||
|
# edit /etc/dsnetconfig.json to taste
|
||||||
|
dsnet add banana > dsnet-banana.conf
|
||||||
|
dsnet add apple > dsnet-apple.conf
|
||||||
|
|
||||||
|
Copy the configuration file to your devices and connect!
|
||||||
|
|
||||||
|
Dsnet assumes a DNS server is running on the server at the moment.
|
||||||
|
|
||||||
To send configurations, ffsend (with separately transferred password) or a local QR code generator may be used.
|
To send configurations, ffsend (with separately transferred password) or a local QR code generator may be used.
|
||||||
|
|
||||||
TODO after first release:
|
TODO after first release:
|
||||||
|
|
||||||
* Hooks for adding routes/ IPtables forwarding rules
|
* Hooks for adding routes/ IPtables forwarding rules
|
||||||
* Forward option
|
* Route entire internet option
|
||||||
* Support for additional subnets in peer config
|
* Support for additional subnets in peer config (with routes)
|
||||||
* Peer endpoint support
|
* Peer endpoint support
|
||||||
|
11
cmd/dsnet.go
11
cmd/dsnet.go
@ -43,7 +43,7 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func help() {
|
func help() {
|
||||||
fmt.Printf(`dsnet is a simple tool to manage a wireguard VPN.
|
fmt.Printf(`dsnet is a simple tool to manage a centralised wireguard VPN.
|
||||||
|
|
||||||
Usage: dsnet <cmd>
|
Usage: dsnet <cmd>
|
||||||
|
|
||||||
@ -52,17 +52,10 @@ Available commands:
|
|||||||
init : Create %s containing default configuration + new keys without loading. Edit to taste.
|
init : Create %s containing default configuration + new keys without loading. Edit to taste.
|
||||||
add : Add a new peer + sync
|
add : Add a new peer + sync
|
||||||
up : Create the interface, run pre/post up, sync
|
up : Create the interface, run pre/post up, sync
|
||||||
sync : Update wireguard configuration from %s after validating
|
|
||||||
report : Generate a JSON status report to the location configured in %s.
|
report : Generate a JSON status report to the location configured in %s.
|
||||||
remove : Remove a peer by hostname provided as argument + sync
|
remove : Remove a peer by hostname provided as argument + sync
|
||||||
down : Destroy the interface, run pre/post down
|
down : Destroy the interface, run pre/post down
|
||||||
|
sync : Update wireguard configuration from %s after validating
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
|
|
||||||
dsnet add > dsnet.conf
|
|
||||||
|
|
||||||
|
|
||||||
`, dsnet.CONFIG_FILE, dsnet.CONFIG_FILE, dsnet.CONFIG_FILE)
|
`, dsnet.CONFIG_FILE, dsnet.CONFIG_FILE, dsnet.CONFIG_FILE)
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user