yggdrasil-network/yggdrasil-go
1
0
Fork 0
mirror of https://github.com/yggdrasil-network/yggdrasil-go.git synced 2025-04-29 22:55:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Vadym Vikulin 2021-09-09 10:21:47 +03:00 • committed by GitHub
parent 910ce15b80
commit f4a4274967
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,19 +1,22 @@
# Mesh # RiV-mesh
[![CircleCI](https://circleci.com/gh/RiV-chain/RiV-mesh.svg?style=shield&circle-token=:circle-token [![CircleCI](https://circleci.com/gh/RiV-chain/RiV-mesh.svg?style=shield&circle-token=:circle-token
)](https://circleci.com/gh/RiV-chain/RiV-mesh) )](https://circleci.com/gh/RiV-chain/RiV-mesh)
## Introduction ## Introduction
Mesh is an early-stage implementation of a fully end-to-end encrypted IPv6 RiV-mesh is an implementation of a fully end-to-end encrypted IPv6
network. It is lightweight, self-arranging, supported on multiple platforms and network, created in the scope to produce the Transport Layer for RiV Chain Blockchain,
allows pretty much any IPv6-capable application to communicate securely with also to facilitate secure conectivity between a wide spectrum of endpoint devices like IoT devices,
other Mesh nodes. Mesh does not require you to have IPv6 Internet desktop computers or even routers.
connectivity - it also works over IPv4. 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 ## Supported Platforms
Mesh 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. EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt.
Please see our [Installation](https://RiV-chain.github.io/installation.html) Please see our [Installation](https://RiV-chain.github.io/installation.html)
@ -41,51 +44,50 @@ To generate static configuration, either generate a HJSON file (human-friendly,
complete with comments): 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 ... or generate a plain JSON file (which is easy to manipulate
programmatically): 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. other configuration such as listen addresses or multicast addresses, etc.
### Run Mesh ### Run RiV-mesh
To run with the generated static configuration: 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 To run in auto-configuration mode (which will use sane defaults and random keys
at each startup, instead of using a static configuration file): at each startup, instead of using a static configuration file):
``` ```
./yggdrasil -autoconf ./mesh -autoconf
``` ```
You will likely need to run Mesh 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 unless you have permission to create TUN/TAP adapters. On Linux this can be done
by giving the Mesh binary the `CAP_NET_ADMIN` capability. by giving the RiV-mesh binary the `CAP_NET_ADMIN` capability.
## Documentation ## Documentation
Documentation is available [on our website](https://RiV-chain.github.io). Documentation is available [on our website](https://RiV-chain.github.io).
- [Installing Mesh](https://RiV-chain.github.io/installation.html) - [Installing RiV-mesh](https://RiV-chain.github.io/installation.html)
- [Configuring Mesh](https://RiV-chain.github.io/configuration.html) - [Configuring RiV-mesh](https://RiV-chain.github.io/configuration.html)
- [Frequently asked questions](https://RiV-chain.github.io/faq.html) - [Frequently asked questions](https://RiV-chain.github.io/faq.html)
- [Version changelog](CHANGELOG.md) - [Version changelog](CHANGELOG.md)
## Community ## Community
Feel free to join us on our [Matrix Feel free to join us on our [Telegram
channel](https://matrix.to/#/#yggdrasil:matrix.org) at `#yggdrasil:matrix.org` channel](https://t.me/rivchain).
or in the `#yggdrasil` IRC channel on [libera.chat](https://libera.chat).
## License ## License