Files
docs_projectmycelium/docs/overview-index.md
mik-tf c769942374 init
2025-11-25 15:27:56 -05:00

66 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
slug: /
displayed_sidebar: null
wrapperClassName: overview-doc
---
# Project Mycelium Documentation
Welcome to the official documentation for **Project Mycelium**.
This site is organized around the core building blocks of the Mycelium stack:
- **Network** The Mycelium IPv6 overlay network for secure, encrypted connectivity.
- **Cloud** Mycelium Cloud for Kubernetes clusters on decentralized infrastructure.
- **VDC** Virtual Data Centers for full cloud environments you control.
- **AI Agent Framework** Mycelium Agents (coming 2026) for sovereign, distributed AI.
- **Hosters** Individuals and organizations who contribute capacity to the grid.
Use the top navigation to jump directly to any of these areas.
## Who This Documentation Is For
- **Developers** who want to build on the Mycelium Network and Mycelium Cloud.
- **Organizations** who need sovereign cloud, data residency, and compliance.
- **Hosters** (ThreeFold "farmers") who want to run nodes and earn rewards.
## High-Level Architecture
At a high level, Project Mycelium combines:
1. **Mycelium Network**
A cryptographic IPv6 overlay that connects devices, nodes, and clusters in a secure peer-to-peer mesh.
2. **Mycelium Cloud**
A platform to deploy Kubernetes clusters on the decentralized ThreeFold Grid, using Mycelium Network for connectivity.
3. **Virtual Data Centers (VDCs)**
Composable environments built on top of Mycelium Cloud for applications, databases, internal services, and full personal/organizational clouds.
4. **AI Agent Framework**
A forthcoming framework that lets you run private, distributed AI agents inside environments you control.
5. **Hosters**
Node operators who provide compute, storage, and network capacity to the ecosystem and earn rewards for doing so.
Each section of this documentation dives into one of these layers.
## Where to Start
- If you want **secure networking between devices and clusters**:
- Start with **[Network](/network)**.
- If you want to **deploy Kubernetes clusters on decentralized infrastructure**:
- Start with **[Cloud](/cloud)**.
- If you are a **hoster / farmer** interested in running nodes and earning SPORE:
- Start with **[Hosters](/hosters)**.
- If you want to understand how **Virtual Data Centers** and the **AI Agent Framework** fit in:
- Read the overviews for **[VDC](/vdc)** and **[AI Agent Framework](/ai-agent-framework)**.
## Related Resources
- **Main website** [www.projectmycelium.com](https://www.projectmycelium.com)
- **Mycelium Cloud** [myceliumcloud.tf](https://myceliumcloud.tf)