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

cleaned up develop branch

Browse source
This commit is contained in:
vadym 2021-09-09 10:55:30 +03:00
parent bfe42d8899
commit 2d36105eeb
17 changed files with 102 additions and 817 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,22 +1,19 @@
# RiV-mesh
# Yggdrasil
[![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
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.
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.
## Supported Platforms
RiV-mesh works on a number of platforms, including Linux, macOS, Ubiquiti
Yggdrasil works on a number of platforms, including Linux, macOS, Ubiquiti
EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt.
Please see our [Installation](https://RiV-chain.github.io/installation.html)
@ -57,7 +54,7 @@ programmatically):
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 RiV-mesh
### Run Yggdrasil
To run with the generated static configuration:
```
@ -71,23 +68,24 @@ at each startup, instead of using a static configuration file):
./mesh -autoconf
```
You will likely need to run RiV-mesh as a privileged user or under `sudo`,
You will likely need to run Yggdrasil 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 RiV-mesh binary the `CAP_NET_ADMIN` capability.
by giving the Yggdrasil binary the `CAP_NET_ADMIN` capability.
## Documentation
Documentation is available [on our website](https://RiV-chain.github.io).
- [Installing RiV-mesh](https://RiV-chain.github.io/installation.html)
- [Configuring RiV-mesh](https://RiV-chain.github.io/configuration.html)
- [Installing Yggdrasil](https://RiV-chain.github.io/installation.html)
- [Configuring Yggdrasil](https://RiV-chain.github.io/configuration.html)
- [Frequently asked questions](https://RiV-chain.github.io/faq.html)
- [Version changelog](CHANGELOG.md)
## Community
Feel free to join us on our [Telegram
channel](https://t.me/rivchain).
Feel free to join us on our [Matrix
channel](https://matrix.to/#/#mesh:matrix.org) at `#mesh:matrix.org`
or in the `#mesh` IRC channel on [libera.chat](https://libera.chat).
## License