revert Merge pull request 'Remove clanModules/*' (#4202) from remove-modules into main Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4202 See: https://git.clan.lol/clan/clan-core/issues/4365 Not all modules are migrated. If they are not migrated, we need to write migration docs and please display the link to the migration docs
31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
---
|
|
description = "End-2-end encrypted IPv6 overlay network"
|
|
categories = ["System", "Network"]
|
|
features = [ "inventory", "deprecated" ]
|
|
---
|
|
Mycelium is an IPv6 overlay network written in Rust. Each node that joins the overlay network will receive an overlay network IP in the 400::/7 range.
|
|
|
|
Features:
|
|
- Mycelium, is locality aware, it will look for the shortest path between nodes
|
|
- All traffic between the nodes is end-2-end encrypted
|
|
- Traffic can be routed over nodes of friends, location aware
|
|
- If a physical link goes down Mycelium will automatically reroute your traffic
|
|
- The IP address is IPV6 and linked to private key
|
|
- A simple reliable messagebus is implemented on top of Mycelium
|
|
- Mycelium has multiple ways how to communicate quic, tcp, ... and we are working on holepunching for Quick which means P2P traffic without middlemen for NATted networks e.g. most homes
|
|
- Scalability is very important for us, we tried many overlay networks before and got stuck on all of them, we are trying to design a network which scales to a planetary level
|
|
- You can run mycelium without TUN and only use it as reliable message bus.
|
|
|
|
|
|
An example configuration might look like this in the inventory:
|
|
```nix
|
|
mycelium.default = {
|
|
roles.peer.machines = [
|
|
"berlin"
|
|
"munich"
|
|
];
|
|
};
|
|
```
|
|
|
|
This will add the machines named `berlin` and `munich` to the `mycelium` vpn.
|