From 29b5e427e75f4a2312979389ea8e73dbb9268729 Mon Sep 17 00:00:00 2001 From: k4yt3x Date: Mon, 15 Oct 2018 13:35:18 -0400 Subject: [PATCH] updated usages --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 48 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3466e90..fb81e2e 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ WireGuard mesh configurator is a tool that will help you generating peer configu ## Usages +### Installing WGC + Clone the repository and enter it. ``` @@ -36,16 +38,54 @@ $ git clone https://github.com/K4YT3X/wireguard-mesh-configurator.git $ cd wireguard-mesh-configurator/ ``` -Create a temporary folder for exporting configuration files. - -``` -$ mkdir /tmp/wireguard -``` - Run the tool. ``` -$ python3 wireguard_mesh_configurator.py +$ python3 wireguard_mesh_configurator.py interactive ``` -Then you will find all the generated configuration files under `/tmp/wireguard`. \ No newline at end of file +or + +``` +$ python3 wireguard_mesh_configurator.py int +``` + +### Creating a Profile + +Run the `NewProfile` command to create a new profile. + +``` +[WGC]> NewProfile # Create new profile +``` + +Then the peer enrolling wizard will ask you for all the information needed for all the peers. Select `n` when being asked if you want to add a new peer to end the wizard. + +### Generating Configurations + +Run the following command to dump your currently-loaded profile into configuration files and export them to `output path`. + +``` +[WGC]> GenerateConfigurations [output path] +``` + +### Viewing All Peers + +To view all the peers configurations in the current profile: + +``` +[WGC]> ShowPeers +``` + +### Saving / Loading Profiles + +To save a profile: + +``` +[WGC]> SaveProfile [output path] +``` + +To load a profile: + +``` +[WGC]> LoadProfile [output path] +```