Mycelium User Guide

A comprehensive, user-friendly guide for using Mycelium - an IPv6 overlay network for secure device connections.

📚 Documentation

The documentation is available in two locations:

• GitHub Pages (Recommended): https://threefoldtech.github.io/www_myceliumguide/
• Source Files: /docs directory

📖 Contents

• Installation - Get Mycelium running on Linux, macOS, Windows, iOS, and Android
• Quick Start - Connect to the network in under 5 minutes
• Configuration - Customize your setup with config files and CLI options
• Usage - Daily usage patterns, SOCKS5 proxy, and real-world examples
• Troubleshooting - Common issues and solutions

🚀 Quick Links

• Mycelium Project Repository
• Public Peers List
• SOCKS5 Proxy Setup

🛠️ Local Development

To preview the documentation locally:

cd docs
jekyll serve

Visit http://localhost:4000/www_myceliumguide/

📝 Contributing

Contributions are welcome! To improve the documentation:

1. Fork this repository
2. Make your changes in the /docs directory
3. Test locally with Jekyll
4. Submit a pull request

📄 License

This documentation is part of the Mycelium project. See the main repository for license information.

🔗 Related Resources

• Mycelium Technical Documentation
• ThreeFold Tech