5
0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2024-11-14 03:20:27 +00:00
yggdrasil-network.github.io/index.md

34 lines
3.4 KiB
Markdown
Raw Normal View History

2018-03-11 21:22:45 +00:00
---
tags: dontlink
2018-07-23 16:39:34 +00:00
sitemap: true
2018-03-11 21:22:45 +00:00
---
2018-03-06 17:39:25 +00:00
# Introduction
2018-03-06 14:02:44 +00:00
2018-06-13 18:58:16 +00:00
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.
2018-05-08 23:19:32 +00:00
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, and aims to implement some novel local backpressure routing techniques. In theory, Yggdrasil should scale well on networks with internet-like topologies. Take a look at the [About](about.md) page for a detailed overview.
2018-03-06 14:02:44 +00:00
2018-03-06 17:39:25 +00:00
## Project Status
2018-03-06 17:36:02 +00:00
2020-04-01 22:22:28 +00:00
The project is currently in early stages but it is being actively developed. We have recently released [version 0.3.14](changelog.md) and are still regularly working on updates.
2018-03-06 17:36:02 +00:00
2018-12-09 12:08:59 +00:00
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 and even some video streams, large file transfers and performance tests. We have a number of [internal services](services.md) available, contributed and operated by the community.
2018-06-29 22:06:16 +00:00
It is entirely possible that occasional breaking changes may still happen in future versions but generally Yggdrasil works well and has proven to be reasonably stable so far, with recent builds reaching weeks of uptime without crashes or failures.
2018-03-06 17:36:02 +00:00
2018-06-29 22:05:50 +00:00
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!
2018-05-08 23:19:32 +00:00
2018-03-06 17:39:25 +00:00
## Implementation
2018-03-06 17:36:02 +00:00
2020-02-17 22:55:25 +00:00
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](platform-linux.md), [Windows](platform-windows.md), [macOS](platform-macos.md), FreeBSD, OpenBSD and [Ubiquiti EdgeOS](platform-edgerouter.md)) although with various minor caveats. See the [Platforms](platforms.md) page for more information.
2018-03-06 17:48:51 +00:00
## Get Involved
2018-05-08 23:19:32 +00:00
If you are interested in or would like to get involved in the Yggdrasil project, please feel free to join us!
2018-03-06 17:48:51 +00:00
2018-06-29 22:05:50 +00:00
- Set up Yggdrasil on your [own computer or router](platforms.md) and join the network - the bigger the network grows, the better understanding we will get of how Yggdrasil can scale!
2018-03-06 17:48:51 +00:00
- 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/))
2018-09-25 19:21:01 +00:00
- Alternatively, come and chat to us on the [Freenode IRC network](irc://chat.freenode.net/yggdrasil) in `#yggdrasil`
2018-05-08 23:19:32 +00:00
- 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