From 8c1cf88e0756b2a506bd6039ee468121cea6413d Mon Sep 17 00:00:00 2001 From: braginini Date: Thu, 6 May 2021 14:40:51 +0200 Subject: [PATCH] docs: readme formatting --- README.md | 37 ++++++++++++++++--------------------- 1 file changed, 16 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 0ed314914..828cd86ac 100644 --- a/README.md +++ b/README.md @@ -4,34 +4,30 @@ A WireGuard®-based mesh network that connects your devices into a single privat ### Why using Wiretrustee? -* Connect multiple devices at home, office or anywhere else to each other via a secure peer-to-peer Wireguard VPN tunnel. +* Connect multiple devices to each other via a secure peer-to-peer Wireguard VPN tunnel. At home, the office, or anywhere else. * No need to open ports and expose public IPs on the device. -* Automatic reconnects in case of network failures or switches. +* Automatically reconnects in case of network failures or switches. * Automatic NAT traversal. -* Relay server fallback in case of an unsuccessful peer-to-peer connection. +* Relay server fallback in case of an unsuccessful peer-to-peer connection. * Private key never leaves your device. * Works on ARM devices (e.g. Raspberry Pi). ### A bit on Wiretrustee internals -* Wiretrustee uses WebRTC ICE implemented in [pion/ice library](https://github.com/pion/ice) to discover connection candidates -when establishing a peer-to-peer connection between devices. -* A connection session negotiation between peers is achieved with Wiretrustee Signalling server [signal](signal/) -* Contents of the messages sent between peers through the signalling server are encrypted with Wireguard keys making it impossible - to inspect them. +* Wiretrustee uses WebRTC ICE implemented in [pion/ice library](https://github.com/pion/ice) to discover connection candidates when establishing a peer-to-peer connection between devices. +* A connection session negotiation between peers is achieved with the Wiretrustee Signalling server [signal](signal/) +* Contents of the messages sent between peers through the signalling server are encrypted with Wireguard keys, making it impossible to inspect them. The routing of the messages on a Signalling server is based on public Wireguard keys. -* Sometimes NAT-traversal is unsuccessful due to strict NATs (e.g. mobile carrier grade NAT). -For that matter there is a support for a relay server fallback (TURN). In this case a secure Wireguard tunnel is established via a TURN server. +* Occasionally, the NAT-traversal is unsuccessful due to strict NATs (e.g. mobile carrier grade NAT). + For that matter, there is support for a relay server fallback (TURN). So in case, the (NAT-traversal is unsuccessful???), a secure Wireguard tunnel is established via TURN server. [Coturn](https://github.com/coturn/coturn) is the one that has been successfully used for STUN and TURN in Wiretrustee setups. ### What Wiretrustee is not doing (yet): -* Wireguard key management. For that reason you need to generate peer keys and specify them on Wiretrustee initialization step. -However, the support for the key management feature is in our roadmap. -* Peer address assignment. You have to specify a unique peer local address (e.g. 10.30.30.1/24) when configuring Wiretrustee - Same as for the key management it is in our roadmap. +* Wireguard key management. In consequence, you need to generate peer keys and specify them on Wiretrustee initialization step. However, the support for the key management feature is on our roadmap. +* Peer address management. You have to specify a unique peer local address (e.g. 10.30.30.1/24) when configuring Wiretrustee + The peer management assignment is on our roadmap too. ### Installation -1. Checkout Wiretrustee releases - https://github.com/wiretrustee/wiretrustee/releases +1. Checkout Wiretrustee [releases](https://github.com/wiretrustee/wiretrustee/releases) 2. Download the latest release: ```shell wget https://github.com/wiretrustee/wiretrustee/releases/download/v0.0.4/wiretrustee_0.0.4_linux_amd64.rpm @@ -49,12 +45,11 @@ sudo wiretrustee init \ --wgLocalAddr 10.30.30.1/24 \ --log-level info ``` -It is important to mention that ```wgLocalAddr``` parameter has to be unique across your network -E.g. if you have a Peer A with wgLocalAddr=10.30.30.1/24 then another Peer B can have a wgLocalAddr=10.30.30.2/24 - -If for some reason you already have a generated Wireguard key you can specify it with ```--wgKey``` parameter. -If not specified then a new one will be generated, and it's corresponding public key will be output in the log. +It is important to mention that the ```wgLocalAddr``` parameter has to be unique across your network. +E.g. if you have Peer A with ```wgLocalAddr=10.30.30.1/24``` then another Peer B can have ```wgLocalAddr=10.30.30.2/24``` +If for some reason, you already have a generated Wireguard key, you can specify it with the ```--wgKey``` parameter. +If not specified, then a new one will be generated, and its corresponding public key will be output to the log. A new config will be generated and stored under ```/etc/wiretrustee/config.json``` 5. Add a peer to connect to.