1. added multipath protocol and schema suport

2. added SCTP protocol and schema support
3. added set of NAS models support (Asustor, ReadyNAS, Drobo, QNAP, WD, Synology, Terramaster)
4. moved to fc00::/7 private segment
5. added Windows, MacOS and Linux UI for peers edit and current status

README.md

@@ -1,21 +1,28 @@
-# Yggdrasil
+# RiV-mesh first self arranging mesh network with link aggregation.
 
-[![Build status](https://github.com/yggdrasil-network/yggdrasil-go/actions/workflows/ci.yml/badge.svg)](https://github.com/yggdrasil-network/yggdrasil-go/actions/workflows/ci.yml)
+[![CircleCI](https://circleci.com/gh/RiV-chain/RiV-mesh.svg?style=shield&circle-token=:circle-token
+)](https://circleci.com/gh/RiV-chain/RiV-mesh)
+
+## Why fork?
+RiV-mesh is fork of Yggdrasil which is great project. Starting from Yggdrasil 0.4 dev team removed CKR feature which is a core for secure tunneling like VPN does. RiV-mesh gets back CKR feature. Second reason: Yggdrasil uses deprecated 200::/7 IPv6 address pool which can be assigned for some network in future, unlike this fc00::/7 is safe and has been taken for RiV-mesh.
 
 ## Introduction
 
-Yggdrasil is an early-stage implementation of a fully end-to-end encrypted IPv6
-network. It is lightweight, self-arranging, supported on multiple platforms and
-allows pretty much any IPv6-capable application to communicate securely with
-other Yggdrasil nodes. Yggdrasil does not require you to have IPv6 Internet
-connectivity - it also works over IPv4.
+RiV-mesh is an implementation of a fully end-to-end encrypted IPv6
+network, created in the scope to produce the Transport Layer for RiV Chain Blockchain,
+also to facilitate secure conectivity between a wide spectrum of endpoint devices like IoT devices,
+desktop computers or even routers.
+It is lightweight, self-arranging, supported on multiple
+platforms and allows pretty much any IPv6-capable application
+to communicate securely with other RiV-mesh nodes.
+RiV-mesh does not require you to have IPv6 Internet connectivity - it also works over IPv4.
 
 ## Supported Platforms
 
-Yggdrasil works on a number of platforms, including Linux, macOS, Ubiquiti
+RiV-mesh works on a number of platforms, including Linux, macOS, Ubiquiti
 EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt.
 
-Please see our [Installation](https://yggdrasil-network.github.io/installation.html)
+Please see our [Installation](https://RiV-chain.github.io/installation.html) 
 page for more information. You may also find other platform-specific wrappers, scripts
 or tools in the `contrib` folder.
 
@@ -40,52 +47,85 @@ To generate static configuration, either generate a HJSON file (human-friendly,
 complete with comments):
 
 ```
-./yggdrasil -genconf > /path/to/yggdrasil.conf
+./mesh -genconf > /path/to/mesh.conf
 ```
 
 ... or generate a plain JSON file (which is easy to manipulate
 programmatically):
 
 ```
-./yggdrasil -genconf -json > /path/to/yggdrasil.conf
+./mesh -genconf -json > /path/to/mesh.conf
 ```
 
-You will need to edit the `yggdrasil.conf` file to add or remove peers, modify
+You will need to edit the `mesh.conf` file to add or remove peers, modify
 other configuration such as listen addresses or multicast addresses, etc.
 
-### Run Yggdrasil
+### Run RiV-mesh
 
 To run with the generated static configuration:
 
 ```
-./yggdrasil -useconffile /path/to/yggdrasil.conf
+./mesh -useconffile /path/to/mesh.conf
 ```
 
 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
+./mesh -autoconf
 ```
 
-You will likely need to run Yggdrasil as a privileged user or under `sudo`,
+You will likely need to run RiV-mesh as a privileged user or under `sudo`,
 unless you have permission to create TUN/TAP adapters. On Linux this can be done
-by giving the Yggdrasil binary the `CAP_NET_ADMIN` capability.
+by giving the RiV-mesh binary the `CAP_NET_ADMIN` capability.
 
 ## Documentation
 
-Documentation is available [on our website](https://yggdrasil-network.github.io).
+Documentation is available [on our website](https://riv-chain.github.io/RiV-mesh/).
 
-- [Installing Yggdrasil](https://yggdrasil-network.github.io/installation.html)
-- [Configuring Yggdrasil](https://yggdrasil-network.github.io/configuration.html)
-- [Frequently asked questions](https://yggdrasil-network.github.io/faq.html)
+- [Installing RiV-mesh](https://riv-chain.github.io/RiV-mesh/)
+- [Configuring RiV-mesh](https://riv-chain.github.io/RiV-mesh/)
+- [Frequently asked questions](https://riv-chain.github.io/RiV-mesh/)
 - [Version changelog](CHANGELOG.md)
 
 ## Community
 
-Feel free to join us on our [Matrix
-channel](https://matrix.to/#/#yggdrasil:matrix.org) at `#yggdrasil:matrix.org`
-or in the `#yggdrasil` IRC channel on [libera.chat](https://libera.chat).
+Feel free to join us on our [Telegram
+channel](https://t.me/rivchain).
+
+## Public peers
+If you are operating RiV-mesh peer and may create your pool request with your new per or use existing one https://github.com/RiV-chain/public-peers
+
+## Known issues
+
+### 1. Log message:
+```
+An error occurred starting multicast: listen udp6 [::]:9001: socket: address family not supported by protocol
+```
+and
+```
+An error occurred starting TUN/TAP: operation not supported
+```
+
+### Caused by:
+The device has no IPv6 support
+
+
+### 2. Log message:
+```
+An error occurred starting TUN/TAP: permission denied
+```
+
+### Caused by:
+IPv6 support is not enabled. See the solution: https://github.com/yggdrasil-network/yggdrasil-go/issues/479#issuecomment-519512395
+
+### 3. Mesh infinite output in log:
+ Connected SCTP ...
+ 
+ Disconnected SCTP ...
+
+### Caused by:
+Docker interface docker0 is conflicting with SCTP bind process. The issue can be resolved by removing docker.
 
 ## License