This commit is contained in:
vadym 2021-09-09 10:19:40 +03:00
parent af9260c802
commit 1dce2d51be
42 changed files with 187 additions and 187 deletions

View file

@ -1,22 +1,22 @@
# Yggdrasil
# Mesh
[![CircleCI](https://circleci.com/gh/yggdrasil-network/yggdrasil-go.svg?style=shield&circle-token=:circle-token
)](https://circleci.com/gh/yggdrasil-network/yggdrasil-go)
[![CircleCI](https://circleci.com/gh/RiV-chain/RiV-mesh.svg?style=shield&circle-token=:circle-token
)](https://circleci.com/gh/RiV-chain/RiV-mesh)
## Introduction
Yggdrasil is an early-stage implementation of a fully end-to-end encrypted IPv6
Mesh 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
other Mesh nodes. 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
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.
@ -54,7 +54,7 @@ programmatically):
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
### Run Mesh
To run with the generated static configuration:
```
@ -68,17 +68,17 @@ at each startup, instead of using a static configuration file):
./yggdrasil -autoconf
```
You will likely need to run Yggdrasil as a privileged user or under `sudo`,
You will likely need to run 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 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).
- [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 Mesh](https://RiV-chain.github.io/installation.html)
- [Configuring Mesh](https://RiV-chain.github.io/configuration.html)
- [Frequently asked questions](https://RiV-chain.github.io/faq.html)
- [Version changelog](CHANGELOG.md)
## Community