mirror of
https://github.com/cwinfo/yggdrasil-network.github.io.git
synced 2024-11-14 03:20:27 +00:00
30 lines
3.0 KiB
Markdown
30 lines
3.0 KiB
Markdown
---
|
|
tags: dontlink
|
|
---
|
|
|
|
# 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.
|
|
|
|
Although Yggdrasil shares many similarities with [cjdns](https://github.com/cjdelisle/cjdns), it employs a different routing algorithm based on a globally-agreed spanning tree and greedy routing in a metric space. In theory, an Yggdrasil network should scale well on networks with internet-like topologies. Take a look at the [About](about.md) page for a detailed overview.
|
|
|
|
## Project Status
|
|
|
|
The project is currently in very early stages but it is being actively developed. We are currently at [version 0.2](https://github.com/yggdrasil-network/yggdrasil-go/milestone/1), which is our first major alpha release. Yggdrasil is considered to be alpha quality at this point. It is entirely possible that breaking changes may still happen but generally it works well and has proven to be reasonably stable so far, with recent builds reaching weeks of uptime without crashes or failures.
|
|
|
|
Currently we don't have any specific releases, but binaries are [automatically built](https://circleci.com/gh/yggdrasil-network/yggdrasil-go) each time that we commit to the Git repository for a number of platforms. Feel free to [download them](builds.md), play with them, stress-test them or even use them in your own environments. However, be prepared to upgrade frequently and we wouldn't recommend relying on Yggdrasil for anything mission-critical at this stage!
|
|
|
|
A small number of users have been using and stress-testing Yggdrasil quite heavily for a number of purposes, including but not limited to secure remote access (SSH and VNC), access to Matrix, Jabber and IRC servers (including a Matrix-IRC bridge that runs solely over Yggdrasil) and even some large file transfers and performance tests.
|
|
|
|
## Implementation
|
|
|
|
Yggdrasil is written in Go. The codebase is fairly small and easy to navigate. It has been tested on a number of platforms (including Linux, Windows, macOS, NetBSD, FreeBSD, OpenBSD and Ubiquiti EdgeOS) although with various minor caveats. See the [Platforms](platforms.md) page for more information.
|
|
|
|
## Get Involved
|
|
|
|
If you are interested in or would like to get involved in the Yggdrasil project, please feel free to join us!
|
|
|
|
- Come and chat to us in our [Matrix channel](https://matrix.to/#/#yggdrasil:matrix.org) (or even [read our channel backlog](https://view.matrix.org/room/!DwmKuvGvRKciqyFcxv:matrix.org/))
|
|
- Alternatively, come and chat to us on the [Freenode IRC network](irc://chat.freenode.net/yggdrasil) in `#yggdrasil`.
|
|
- Take a look at our [GitHub](https://github.com/yggdrasil-network/yggdrasil-go), and in particular, the [Open Issues](https://github.com/yggdrasil-network/yggdrasil-go/issues) which contain bugs waiting to be fixed, problems waiting to be solved and plenty of in-depth discussions about our implementation or design choices
|