From 7478c8ba2b583a275af49c9b0801702d53d1c3a6 Mon Sep 17 00:00:00 2001 From: Neil Alexander Date: Wed, 13 Mar 2019 20:08:50 +0000 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a9a9d968..8c1f1684 100644 --- a/README.md +++ b/README.md @@ -55,23 +55,27 @@ specifying the `GOOS` and `GOARCH` environment variables, e.g. `GOOS=windows ## Running +### Generate configuration + To generate static configuration, either generate a HJSON file (human-friendly, complete with comments): ``` -./yggdrasil -genconf /path/to/yggdrasil.conf +./yggdrasil -genconf > /path/to/yggdrasil.conf ``` ... or generate a plain JSON file (which is easy to manipulate programmatically): ``` -./yggdrasil -genconf /path/to/yggdrasil.conf -json +./yggdrasil -genconf -json > /path/to/yggdrasil.conf ``` You will need to edit the `yggdrasil.conf` file to add or remove peers, modify other configuration such as listen addresses or multicast addresses, etc. +### Run Yggdrasil + To run with the generated static configuration: ``` ./yggdrasil -useconffile /path/to/yggdrasil.conf @@ -81,7 +85,7 @@ To run in auto-configuration mode (which will use sane defaults and random keys at each startup, instead of using a static configuration file): ``` -./yggdrasil --autoconf +./yggdrasil -autoconf ``` You will likely need to run Yggdrasil as a privileged user or under `sudo`, @@ -90,8 +94,8 @@ by giving the Yggdrasil binary the `CAP_NET_ADMIN` capability. ## Documentation -Documentation is available on our [`GitHub -Pages`](https://yggdrasil-network.github.io) site, or in the base submodule +Documentation is available on our [GitHub +Pages](https://yggdrasil-network.github.io) site, or in the base submodule repository within `doc/yggdrasil-network.github.io`. - [Configuration file options](https://yggdrasil-network.github.io/configuration.html)