This commit is contained in:
2025-04-09 07:11:38 +02:00
parent b93894632a
commit 5e4dcbf77c
37 changed files with 2450 additions and 8 deletions

View File

View File

@@ -0,0 +1,38 @@
---
title: Features Mycelium Network
sidebar_position: 1
---
Mycelium is a locality-aware, end-to-end encrypted network designed for efficient and secure communication between nodes. Below are its key features:
## What Makes Mycelium Unique
1. **Locality Awareness**
Mycelium identifies the shortest path between nodes, optimizing communication based on location.
2. **End-to-End Encryption**
All traffic between nodes is encrypted, ensuring secure data transmission.
3. **Traffic Routing Over Friend Nodes**
Traffic can be routed through nodes of trusted friends, maintaining location awareness.
4. **Automatic Rerouting**
If a physical link fails, Mycelium automatically reroutes traffic to ensure uninterrupted connectivity.
5. **Your network Address Linked to Private Key**
Each node is assigned an IPv6 network address that is cryptographically linked to its private key.
6. **Scalability**
Mycelium is designed to scale to a planetary level. The team has evaluated multiple overlay networks in the past and is focused on overcoming scalability challenges.
## Tech
1. **Flexible Deployment**
Mycelium can be run without a TUN interface, allowing it to function solely as a reliable message bus.
2. **Reliable Message Bus**
Mycelium includes a simple and reliable message bus built on top of its network layer.
1. **Multiple Communication Protocols**
Mycelium supports various communication methods, including QUIC and TCP. The team is also developing hole-punching for QUIC, enabling direct peer-to-peer (P2P) traffic without intermediaries.

View File

@@ -0,0 +1,23 @@
---
title: Download the App
sidebar_position: 4
---
The Mycelium app is available for Android, Windows, macOS and iOS.
For Linux, read the [Linux Installation](../experts/03_linux-installation.md) section.
## Download Links
You can download the Mycelium app with the following links:
- [iOS and macOS](https://apps.apple.com/app/id6504277565)
- Download the app from the App Store
- [Android](https://play.google.com/store/apps/details?id=tech.threefold.mycelium)
- Download the app from the Google Play Store
- [Windows](https://github.com/threefoldtech/myceliumflut/releases)
- Go to the official Mycelium release page and download the latest `.exe`
## Upcoming Updates
- The user interface (UI) will be drastically improved in upcoming releases to better represent the available features.

View File

@@ -0,0 +1,48 @@
---
title: Use the App
sidebar_position: 5
---
## Start Mycelium
To start Mycelium, simply open the app and click on `Start`.
![](./img/mycelium_1.png)
> Note for Windows Users: The Mycelium app must be run as an administrator to function properly. Right-click on the application icon and select "Run as administrator" to ensure proper network connectivity.
## Stop or Restart Mycelium
To stop or restart Mycelium, click on the appropriate button.
![](./img/mycelium_2.png)
## Add Peers
You can add different Mycelium peers in the `Peers` window.
Simply add peers and then either start or restart the app.
![](./img/mycelium_3.png)
You can consult the [Mycelium hosted public nodes](../experts/04_additional-information.md) to find more peers.
For example, if you want to add the node with the IPv4 address `5.78.122.16` with the tcp port `9651`, simply add the following line then start or restart the app.
```
tcp://5.78.122.16:9651
```
## Mycelium Address
When you use the Mycelium app, you are assigned a unique Mycelium address.
To copy the Mycelium address, click on the button on the right of the address.
![](./img/mycelium_4.png)
## Deploy on the Grid with Mycelium
Once you've installed Mycelium, you can deploy on the ThreeFold Grid and connect to your workload using Mycelium.
As a starter, you can explore the ThreeFold Grid and deploy apps on the [ThreeFold Dashboard](https://manual.grid.tf/documentation/dashboard/dashboard.html) using Mycelium to connect.

View File

@@ -0,0 +1,8 @@
{
"label": "Get Started",
"position": 4,
"link": {
"type": "generated-index",
"description": "Get started With Mycelium Network."
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB