init
This commit is contained in:
mik-tf
174
docs/network/install.md
Normal file
174
docs/network/install.md
Normal file
@@ -0,0 +1,174 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Install Mycelium Network
|
||||
|
||||
The Mycelium app is available for Android, Windows, macOS, and iOS. Installation is simple and user-friendly.
|
||||
|
||||
## 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.
|
||||
|
||||
:::tip 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.
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
## System Requirements
|
||||
|
||||
### For Apps (iOS, Android, macOS, Windows)
|
||||
|
||||
- **OS:** iOS 14+, Android 8+, macOS 11+, Windows 10+
|
||||
- **RAM:** Minimal (runs in background)
|
||||
- **Disk:** ~50 MB
|
||||
- **Network:** Standard internet connection
|
||||
|
||||
### For Linux Command-Line
|
||||
|
||||
- **OS:** Any modern Linux distribution
|
||||
- **RAM:** 50 MB
|
||||
- **Disk:** 20 MB
|
||||
- **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:**
|
||||
|
||||
```bash
|
||||
# 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:**
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
## What's Next?
|
||||
|
||||
Now that Mycelium is installed, connect to the network:
|
||||
|
||||
- **[Quick Start Guide](/network/quick-start)** – Connect in 5 minutes.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- **GitHub Repository** – [github.com/threefoldtech/mycelium](https://github.com/threefoldtech/mycelium)
|
||||
- **Get Help** – [Telegram Community](https://t.me/threefold/1)
|
||||
|
||||
:::tip Ready to Connect?
|
||||
Installation complete. Continue to the **[Quick Start](/network/quick-start)** guide to join the network.
|
||||
:::
|
||||
Reference in New Issue
Block a user