What do you want to build?
The docs aren't organised by feature β they're organised by goal. Pick the scenario that sounds like your weekend project, and we'll walk you through it with config snippets, screenshots, and the inevitable footguns.
Scenarios
End-to-end recipes β start at the goal, finish with a working node.
The Personal Cloud
Replace Dropbox / Google Drive / iCloud.
- Pair a desktop with a VPS
- Create your first vault, set RF
- Add Android β automatic photo sync
- Streaming vs. full-sync vaults
The Secure Comms Hub
Replace Signal / Telegram for your private group.
- Chat vaults & invites
- End-to-end audio + video calls
- Offline UnifiedPush wake-ups
- Compact LAN-pairing for two phones
The S3-compatible Backend
Plug MeshHold into self-hosted apps.
- Enable the S3 listener, bucket = vault alias
- Access keys + per-bucket permissions
- Recipes: Nextcloud, PeerTube, Mastodon, Matrix, ejabberd
- Pleroma, Lemmy, Ente, Restic / rclone, static sites
The Private Mesh VPN
Tunnel your phone through a trusted exit.
- Entry β middle β exit chains
- HTTP CONNECT proxy vs. system VPN
- Management keys (tunnel cap)
- REALITY / SSH masquerade transports
The Home Automation Bridge
Doorbell, Grafana, Pi-camera β all into MeshHold.
- Inbound webhooks (Slack/Mattermost shape)
- GPIO button β video call
- Headless Pi camera (auto-answer)
- Alert routing into chat rooms
The Developer Platform
Build apps on top of MeshHold.
- REST API reference
- Server-Sent Events stream
- MCP / Claude Code integration
- libp2p protocol IDs
The Office / Lab Fleet
A multi-user team mesh.
- Network bootstrap & swarm-key rotation
- Trusted vs. untrusted nodes
- Per-key access & rotation
- Backup & disaster recovery
Core Concepts
Understand the fundamentals.
- Convergent encryption
- Replication factor & reliable nodes
- Vaults, blocks, and hash-chains
- Mesh topology & gossip
Reference
For when you already know what you want.
Configuration reference
Every key in config.yaml β types, defaults, validation rules.
Open βCLI reference
Every meshhold subcommand and flag.
Open βREST API reference
All /api/v1/β¦ endpoints with examples.
Open βArchitecture spec
The long-form design doc β protocols, crypto, invariants.
Open βAnonymous telemetry
What every node reports back, how to switch it off.
Open βCan't find what you need?
The forum is the best place to ask β answers there get folded back into these guides.