5
0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2024-09-19 21:52:31 +00:00
yggdrasil-network.github.io/index.md

25 lines
2.1 KiB
Markdown
Raw Normal View History

2018-03-11 21:22:45 +00:00
---
tags: dontlink
---
2018-03-06 17:39:25 +00:00
# Introduction
2018-03-06 14:02:44 +00:00
2018-03-11 10:22:24 +00:00
Yggdrasil is an early-stage implementation of a fully encrypted IPv6 network. Although Yggdrasil shares many similarities with [cjdns](https://github.com/cjdelisle/cjdns), it also employs a different routing algorithm based on a globally-agreed spanning tree. In theory, an Yggdrasil network should scale well even up to 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
The project is currently in very early stages but it is being actively developed. Yggdrasil is considered to be pre-alpha 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.
2018-03-13 12:42:49 +00:00
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!
2018-03-06 17:36:02 +00:00
2018-03-06 17:39:25 +00:00
## Implementation
2018-03-06 17:36:02 +00:00
2018-03-11 21:22:45 +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, Windows, macOS, NetBSD, FreeBSD, OpenBSD and Ubiquiti EdgeOS) although with various minor caveats. See the [Platforms](platforms.md) page for more information.
2018-03-06 17:48:51 +00:00
## Get Involved
If you are interested in getting involved in the Yggdrasil project, please 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/))
- 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 discussions about our implementation or design choices