diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3a62a37 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.DS_Store +_site diff --git a/assets/.DS_Store b/assets/.DS_Store deleted file mode 100644 index 8c8d961..0000000 Binary files a/assets/.DS_Store and /dev/null differ diff --git a/assets/css/style.scss b/assets/css/style.scss index 5b774f1..119d43c 100644 --- a/assets/css/style.scss +++ b/assets/css/style.scss @@ -3,6 +3,65 @@ @import "jekyll-theme-primer"; +div#indexicons { + margin-top: 2.5em; + margin-bottom: 2em; + display: flex; + flex-direction: row; + flex-wrap: wrap; + justify-content: space-around; +} + +div#indexicons div.icon { + display: flex; + flex-direction: column; + max-width: 10em; + align-items: center; + align-content: stretch; +} + +div#indexicons div.icon img { + width: 3em; +} + +div#indexicons div.icon div { + text-align: center; + font-weight: bold; + margin-top: 1em; +} + +div#indexicons div.icon p { + text-align: center; + margin-top: 1em; +} + +div#indextable { + margin-bottom: 2em; + display: flex; + flex-direction: column; + flex-wrap: wrap; + justify-content: space-around; +} + +div#indextable div.row { + display: flex; + flex-direction: row; + align-items: center; +} + +div#indextable div.row img { + width: 2em; + height: 2em; + margin: 0.5em; + margin-left: 1em; +} + +div#indextable div.row p { + margin-top: 0.5em; + margin-bottom: 0.5em; + margin-left: 0.5em; +} + div.linkmenu { float: right; } diff --git a/assets/images/iconoir/LICENSE b/assets/images/iconoir/LICENSE new file mode 100644 index 0000000..828f826 --- /dev/null +++ b/assets/images/iconoir/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Luca Burgio + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/assets/images/iconoir/cloud-check.svg b/assets/images/iconoir/cloud-check.svg new file mode 100644 index 0000000..8d8923a --- /dev/null +++ b/assets/images/iconoir/cloud-check.svg @@ -0,0 +1,4 @@ + + + + diff --git a/assets/images/iconoir/cpu.svg b/assets/images/iconoir/cpu.svg new file mode 100644 index 0000000..6888323 --- /dev/null +++ b/assets/images/iconoir/cpu.svg @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/assets/images/iconoir/download-circled-outline.svg b/assets/images/iconoir/download-circled-outline.svg new file mode 100644 index 0000000..e9c250a --- /dev/null +++ b/assets/images/iconoir/download-circled-outline.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/assets/images/iconoir/github.svg b/assets/images/iconoir/github.svg new file mode 100644 index 0000000..ac954fb --- /dev/null +++ b/assets/images/iconoir/github.svg @@ -0,0 +1,4 @@ + + + + diff --git a/assets/images/iconoir/group.svg b/assets/images/iconoir/group.svg new file mode 100644 index 0000000..f097c91 --- /dev/null +++ b/assets/images/iconoir/group.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/assets/images/iconoir/lock.svg b/assets/images/iconoir/lock.svg new file mode 100644 index 0000000..bab736e --- /dev/null +++ b/assets/images/iconoir/lock.svg @@ -0,0 +1,3 @@ + + + diff --git a/assets/images/iconoir/multi-bubble.svg b/assets/images/iconoir/multi-bubble.svg new file mode 100644 index 0000000..f718203 --- /dev/null +++ b/assets/images/iconoir/multi-bubble.svg @@ -0,0 +1,4 @@ + + + + diff --git a/assets/images/iconoir/multi-window.svg b/assets/images/iconoir/multi-window.svg new file mode 100644 index 0000000..7ae181a --- /dev/null +++ b/assets/images/iconoir/multi-window.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/assets/images/iconoir/planet.svg b/assets/images/iconoir/planet.svg new file mode 100644 index 0000000..1bd91d4 --- /dev/null +++ b/assets/images/iconoir/planet.svg @@ -0,0 +1,4 @@ + + + + diff --git a/developers.md b/developers.md index 2f3ecc5..fdb50c7 100644 --- a/developers.md +++ b/developers.md @@ -5,11 +5,19 @@ tags: dontlink # Developers -This page is meant to have general developer resources and links to developer tools. It's very much a work-in-progress. +Yggdrasil is written in Go. All of our source code is [available on GitHub](https://github.com/yggdrasil-network/yggdrasil-go). The codebase is fairly small and easy to navigate. + +We welcome contributions, either in the form of [Pull Requests](https://github.com/yggdrasil-network/yggdrasil-go/pulls) or [Issues](https://github.com/yggdrasil-network/yggdrasil-go/issues). As this is a largely hobbyist project at this stage, it may take some time for us to get around to reviewing PRs/issues. + +If you'd like to talk to us about the project or the source code, please join our [Matrix channel](https://matrix.to/#/#yggdrasil:matrix.org). + +## Platforms + +Yggdrasil has been tested on a number of platforms (including Linux, Windows, macOS, FreeBSD, OpenBSD and Ubiquiti EdgeRouter). There are also packages available for a number of distributions/platforms. ## Build Artifacts -Build artifacts from our CI are made available (for a while after building) at: +Build artifacts from our CI are made available (for 30 days after building) for the following GitHub branches: - [`master`](builds.md) (stable) builds - [`develop`](builds-develop.md) (unstable) builds, for testing soon-to-be-released changes diff --git a/index.md b/index.md index ad0f620..aeb618e 100644 --- a/index.md +++ b/index.md @@ -3,23 +3,59 @@ tags: dontlink sitemap: true --- -# Yggdrasil +Yggdrasil is an implementation of a new compact routing scheme and functions as a fully end-to-end encrypted IPv6 network. -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. For more information, see our [about](about.md) page. +It is lightweight, easy to configure, supported on multiple platforms, and allows pretty much any IPv6-capable application to communicate securely with other Yggdrasil nodes. You do not need to have IPv6 Internet connectivity from your ISP — it also works just fine over IPv4. -## Project Status +The highlights of Yggdrasil are that it is: -The project is currently in the alpha stage. You can expect the occasional breaking change and backwards incompatibility, but Yggdrasil is generally stable for day-to-day use. +
+
+ +
Scalable
+

Supports large, complex or even internet-scale topologies

+
+
+ +
Self-healing
+

Network responds quickly to connection failures or mobility events

+
+
+ +
Encrypted
+

Traffic sent across the network is end-to-end encrypted always

+
+
+ +
Peer-to-peer
+

Works entirely ad-hoc by design with no built-in points of centralisation

+
+
+ +
Cross-platform
+

Supported on Linux, macOS, Windows, iOS, Android and more

+
+
-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, FreeBSD, OpenBSD and Ubiquiti EdgeRouter). See our [developers](developers.md) page for more info. +This is still an alpha-stage project and there may be some breaking changes in the future. Despite that, Yggdrasil is generally stable enough for day-to-day use and a small number of users have been using and stress-testing Yggdrasil quite heavily for a variety of use cases. If you are interested in or would like to get involved in the Yggdrasil project, start below: -A small number of users have been using and stress-testing Yggdrasil quite heavily for a variety of use cases. We have a number of [internal services](services.md) available, contributed and operated by the community. +
+
+ +

[Install](installation.md) and [configure](configuration.md) Yggdrasil on your own computer or router to join the network.

+
+
+ +

Come and chat to us in our [Matrix channel](https://matrix.to/#/#yggdrasil:matrix.org), or [read our channel backlog](https://view.matrix.org/room/!DwmKuvGvRKciqyFcxv:matrix.org/).

+
+
+ +

Explore the [internal services](services.md) available on the network, as contributed and operated by our users.

+
+
+ +

Visit our [developers](developers.md) page and our [GitHub](https://github.com/yggdrasil-network/yggdrasil-go). Report bugs and problems to us as [GitHub Issues](https://github.com/yggdrasil-network/yggdrasil-go/issues).

+
+
-## Get Involved - -If you are interested in or would like to get involved in the Yggdrasil project, please feel free to join us! - -- [Install](installation.md) and [configure](configuration.md) Yggdrasil on your own computer or router to join the network. -- Come and chat to us in our [Matrix channel](https://matrix.to/#/#yggdrasil:matrix.org) (or [read our channel backlog](https://view.matrix.org/room/!DwmKuvGvRKciqyFcxv:matrix.org/)) -- Visit our [GitHub](https://github.com/yggdrasil-network/yggdrasil-go), particularly our [Issues](https://github.com/yggdrasil-network/yggdrasil-go/issues) page, to report problems, help debug, or contribute to the code.