tfgrid/docs_tfgrid_get_started
11
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Simplify Mycelium installation with app-focused approach and improve user experience

Browse Source
This commit is contained in:
mik-tf
2025-10-16 08:40:20 -04:00
parent 98e904384b
commit d407d45a87
5 changed files with 239 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

208
docs/mycelium-network/install.md
View File

@@ -4,9 +4,64 @@ sidebar_position: 2
# Install Mycelium
Get Mycelium running on your system in just a few steps.
The Mycelium app is available for Android, Windows, macOS, and iOS. Installation is simple and user-friendly!
## Linux Installation
## Easy Installation (Recommended)
### iOS & macOS
Download the Mycelium app from the App Store:
**[Download from App Store](https://apps.apple.com/app/id6504277565)**
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](https://play.google.com/store/apps/details?id=tech.threefold.mycelium)**
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](https://github.com/threefoldtech/myceliumflut/releases)**
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
<div className="info-box">
### 💡 Super Simple!
The Mycelium app provides an easy graphical interface - no command-line needed. Just install, open, and start connecting!
</div>
## 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.
### Using Pre-built Binaries (Recommended)
@@ -44,81 +99,7 @@ cargo build --release
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
## Docker Installation (Advanced)
Run Mycelium in a container:
@@ -132,69 +113,54 @@ docker run -d \
--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
### For Apps (iOS, Android, macOS, Windows)
- **OS**: Linux, macOS, Windows (64-bit)
- **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)
### 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
### App Not Starting (Windows)
If you get a "command not found" error:
**Windows users**: The app must run as administrator for network connectivity.
- Right-click the app icon
- Select "Run as administrator"
**Linux/macOS:**
### 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`
**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:**
**Permission Denied:**
```bash
# Make the binary executable
chmod +x /usr/local/bin/mycelium
# Run with sudo if needed for network operations
# Run with sudo 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:**
**IPv6 Not Available:**
```bash
# Check if IPv6 is enabled
cat /proc/sys/net/ipv6/conf/all/disable_ipv6
@@ -203,12 +169,6 @@ cat /proc/sys/net/ipv6/conf/all/disable_ipv6
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: