Files
docs_tfgrid_get_started/docs/mycelium-network/install.md

4.7 KiB

sidebar_position
sidebar_position
2

Install Mycelium

The Mycelium app is available for Android, Windows, macOS, and iOS. Installation is simple and user-friendly!

iOS & macOS

Download the Mycelium app from the App Store:

Download from App Store

  1. Open the App Store
  2. Search for "Mycelium" or use the link above
  3. Tap Get or Install
  4. Open the app and you're ready to go!

Android

Download the Mycelium app from Google Play:

Download from Google Play

  1. Open Google Play Store
  2. Search for "Mycelium ThreeFold" or use the link above
  3. Tap Install
  4. Open the app and you're ready to go!

Windows

Download the latest Windows app:

Download for Windows

  1. Go to the releases page
  2. Download the latest .exe file
  3. Double-click to install
  4. Important: Run as administrator for proper network connectivity

💡 Super Simple!

The Mycelium app provides an easy graphical interface - no command-line needed. Just install, open, and start connecting!

What You Get

With the Mycelium app, you get:

  • Easy interface - One-click to start/stop
  • Automatic setup - No configuration needed
  • Peer management - Add peers with a click
  • Your Mycelium address - Copy with one tap
  • Status monitoring - See connection status

Linux Installation (Advanced)

For Linux users, Mycelium is installed via command-line.

  1. Download the latest release:

    wget https://github.com/threefoldtech/mycelium/releases/latest/download/mycelium-linux-x64.tar.gz
    
  2. Extract and install:

    tar -xzf mycelium-linux-x64.tar.gz
    chmod +x mycelium
    sudo mv mycelium /usr/local/bin/
    
  3. Verify installation:

    mycelium --version
    

Building from Source

If you prefer to build from source:

# 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

Docker Installation (Advanced)

Run Mycelium in a container:

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

System Requirements

For Apps (iOS, Android, macOS, Windows)

  • OS: iOS 14+, Android 8+, macOS 11+, Windows 10+
  • RAM: Minimal (runs in background)
  • Disk: ~50MB
  • Network: Standard internet connection

For Linux Command-Line

  • OS: Any modern Linux distribution
  • RAM: 50MB
  • Disk: 20MB
  • Network: IPv6 support (enabled by default on most systems)

Troubleshooting

App Not Starting (Windows)

Windows users: The app must run as administrator for network connectivity.

  • Right-click the app icon
  • Select "Run as administrator"

App Not Connecting

  1. Check internet connection - Ensure you're online
  2. Restart the app - Close and reopen
  3. Add public peers - Use the app's peer management (see Quick Start)
  4. Check firewall - Ensure the app isn't blocked

Linux Command-Line Issues

"Command not found" Error:

  • 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

Permission Denied:

# Make the binary executable
chmod +x /usr/local/bin/mycelium

# Run with sudo for network operations
sudo mycelium --peers tcp://188.40.132.242:9651

IPv6 Not Available:

# 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

What's Next?

Now that Mycelium is installed, let's connect to the network:

Quick Start Guide - Connect in 5 minutes

Additional Resources


:::tip Ready to Connect? Installation complete! Continue to the Quick Start guide to join the network. :::