feat: Add comprehensive documentation structure with farming, mycelium, and cloud guides
This commit is contained in:
mik-tf
229
docs/mycelium-network/install.md
Normal file
229
docs/mycelium-network/install.md
Normal file
@@ -0,0 +1,229 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Install Mycelium
|
||||
|
||||
Get Mycelium running on your system in just a few steps.
|
||||
|
||||
## Linux Installation
|
||||
|
||||
### Using Pre-built Binaries (Recommended)
|
||||
|
||||
1. **Download the latest release:**
|
||||
```bash
|
||||
wget https://github.com/threefoldtech/mycelium/releases/latest/download/mycelium-linux-x64.tar.gz
|
||||
```
|
||||
|
||||
2. **Extract and install:**
|
||||
```bash
|
||||
tar -xzf mycelium-linux-x64.tar.gz
|
||||
chmod +x mycelium
|
||||
sudo mv mycelium /usr/local/bin/
|
||||
```
|
||||
|
||||
3. **Verify installation:**
|
||||
```bash
|
||||
mycelium --version
|
||||
```
|
||||
|
||||
### Building from Source
|
||||
|
||||
If you prefer to build from source:
|
||||
|
||||
```bash
|
||||
# Install Rust if you haven't already
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
|
||||
# Clone and build
|
||||
git clone https://github.com/threefoldtech/mycelium.git
|
||||
cd mycelium/myceliumd
|
||||
cargo build --release
|
||||
|
||||
# Install binary
|
||||
sudo mv target/release/myceliumd /usr/local/bin/mycelium
|
||||
```
|
||||
|
||||
## macOS Installation
|
||||
|
||||
### Using Pre-built Binaries
|
||||
|
||||
1. **Download the latest release:**
|
||||
```bash
|
||||
wget https://github.com/threefoldtech/mycelium/releases/latest/download/mycelium-macos-x64.tar.gz
|
||||
```
|
||||
|
||||
2. **Extract and install:**
|
||||
```bash
|
||||
tar -xzf mycelium-macos-x64.tar.gz
|
||||
chmod +x mycelium
|
||||
sudo mv mycelium /usr/local/bin/
|
||||
```
|
||||
|
||||
3. **Verify installation:**
|
||||
```bash
|
||||
mycelium --version
|
||||
```
|
||||
|
||||
### Using Homebrew (if available)
|
||||
|
||||
```bash
|
||||
brew install threefoldtech/mycelium/mycelium
|
||||
```
|
||||
|
||||
## Windows Installation
|
||||
|
||||
### Using the Installer
|
||||
|
||||
1. **Download the installer:**
|
||||
- Go to [releases page](https://github.com/threefoldtech/mycelium/releases)
|
||||
- Download `mycelium_installer.msi`
|
||||
|
||||
2. **Run the installer:**
|
||||
- Double-click the downloaded `.msi` file
|
||||
- Follow the installation wizard
|
||||
|
||||
3. **Verify installation:**
|
||||
Open Command Prompt and run:
|
||||
```cmd
|
||||
mycelium --version
|
||||
```
|
||||
|
||||
### Manual Installation
|
||||
|
||||
1. Download `mycelium-windows-x64.zip` from the releases page
|
||||
2. Extract to a folder (e.g., `C:\Program Files\Mycelium\`)
|
||||
3. Add the folder to your PATH environment variable
|
||||
4. Open a new Command Prompt and verify with `mycelium --version`
|
||||
|
||||
## Mobile Installation
|
||||
|
||||
### iOS
|
||||
|
||||
Mycelium runs as a mobile app on iOS devices:
|
||||
|
||||
- Available through the project's mobile directory
|
||||
- Requires developer tools for installation
|
||||
- Operates in TUN-only mode for overlay networking
|
||||
|
||||
**Note:** iOS version may have limitations compared to desktop versions due to platform restrictions.
|
||||
|
||||
### Android
|
||||
|
||||
Mycelium has full support on Android:
|
||||
|
||||
- Build from source using the mobile directory
|
||||
- Full TUN interface support
|
||||
- Complete overlay networking functionality
|
||||
|
||||
Check the [GitHub repository](https://github.com/threefoldtech/mycelium) for the latest mobile installation instructions.
|
||||
|
||||
## Docker Installation
|
||||
|
||||
Run Mycelium in a container:
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name mycelium \
|
||||
--cap-add NET_ADMIN \
|
||||
--device /dev/net/tun \
|
||||
--sysctl net.ipv6.conf.all.disable_ipv6=0 \
|
||||
threefoldtech/mycelium:latest \
|
||||
--peers tcp://188.40.132.242:9651
|
||||
```
|
||||
|
||||
## Verify Installation
|
||||
|
||||
After installing, verify Mycelium is working:
|
||||
|
||||
```bash
|
||||
mycelium --help
|
||||
```
|
||||
|
||||
You should see the help output with available commands and options.
|
||||
|
||||
## System Requirements
|
||||
|
||||
### Minimum Requirements
|
||||
|
||||
- **OS**: Linux, macOS, Windows (64-bit)
|
||||
- **RAM**: 50MB
|
||||
- **Disk**: 20MB
|
||||
- **Network**: IPv6 support (enabled by default on most systems)
|
||||
|
||||
### Network Requirements
|
||||
|
||||
- Internet connection
|
||||
- IPv6 capable network stack (standard on modern systems)
|
||||
- No special firewall configuration needed (works with NAT)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Command not found" Error
|
||||
|
||||
If you get a "command not found" error:
|
||||
|
||||
**Linux/macOS:**
|
||||
- Ensure `/usr/local/bin` is in your PATH
|
||||
- Try running with full path: `/usr/local/bin/mycelium`
|
||||
- Check file permissions: `ls -l /usr/local/bin/mycelium`
|
||||
|
||||
**Windows:**
|
||||
- Verify the installation directory is in your PATH
|
||||
- Open a new Command Prompt after installation
|
||||
- Try full path: `"C:\Program Files\Mycelium\mycelium.exe"`
|
||||
|
||||
### Permission Denied
|
||||
|
||||
If you get permission errors when running:
|
||||
|
||||
**Linux/macOS:**
|
||||
```bash
|
||||
# Make the binary executable
|
||||
chmod +x /usr/local/bin/mycelium
|
||||
|
||||
# Run with sudo if needed for network operations
|
||||
sudo mycelium --peers tcp://188.40.132.242:9651
|
||||
```
|
||||
|
||||
**Windows:**
|
||||
- Run Command Prompt as Administrator
|
||||
- Check Windows Firewall settings
|
||||
|
||||
### IPv6 Not Available
|
||||
|
||||
Mycelium requires IPv6. If you get IPv6 errors:
|
||||
|
||||
**Linux:**
|
||||
```bash
|
||||
# Check if IPv6 is enabled
|
||||
cat /proc/sys/net/ipv6/conf/all/disable_ipv6
|
||||
|
||||
# Enable if needed (0 = enabled)
|
||||
sudo sysctl -w net.ipv6.conf.all.disable_ipv6=0
|
||||
```
|
||||
|
||||
**macOS:**
|
||||
IPv6 is enabled by default. Check System Preferences > Network.
|
||||
|
||||
**Windows:**
|
||||
IPv6 is enabled by default. Check Network Adapter properties.
|
||||
|
||||
## What's Next?
|
||||
|
||||
Now that Mycelium is installed, let's connect to the network:
|
||||
|
||||
**[Quick Start Guide](/mycelium-network/quick-start)** - Connect in 5 minutes
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- **Full User Guide**: [threefoldtech.github.io/www_myceliumguide](https://threefoldtech.github.io/www_myceliumguide/)
|
||||
- **GitHub Repository**: [github.com/threefoldtech/mycelium](https://github.com/threefoldtech/mycelium)
|
||||
- **Technical Docs**: Available in the repository
|
||||
- **Get Help**: [Telegram Community](https://t.me/threefoldfarmers)
|
||||
|
||||
---
|
||||
|
||||
:::tip Ready to Connect?
|
||||
Installation complete! Continue to the **[Quick Start](/mycelium-network/quick-start)** guide to join the network.
|
||||
:::
|
||||
Reference in New Issue
Block a user