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/quick-start.md
View File

@@ -4,35 +4,75 @@ sidebar_position: 3
# Quick Start
Get connected to the Mycelium network in under 5 minutes.
Get connected to the Mycelium network in under 5 minutes!
## Step 1: Connect to Public Peers
## Using the Mycelium App (Easy)
Start your Mycelium node and connect to the global network:
If you're on iOS, Android, macOS, or Windows - use the app for the easiest experience.
### Step 1: Open the App
1. Open the Mycelium app you installed
2. You'll see a simple interface with a **Start** button
### Step 2: Start Mycelium
1. Click the **Start** button
2. The app will automatically connect to the network
3. That's it! You're now on the Mycelium network
<div className="info-box">
### 💡 That's It!
The app handles everything automatically. No configuration needed!
</div>
### Step 3: Get Your Mycelium Address
Your unique Mycelium IPv6 address is shown in the app:
1. Look for your address in the main screen
2. Click the **copy button** next to it to copy your address
3. Share this address with others to let them connect to you
### Step 4: Add More Peers (Optional)
For better connectivity, you can add public peers:
1. Click on the **Peers** section in the app
2. Add peer addresses (see list below)
3. Click **Restart** to connect to the new peers
**Example peers to add:**
```
tcp://188.40.132.242:9651
tcp://185.69.166.8:9651
tcp://65.21.231.58:9651
```
### Step 5: Test Your Connection
Try connecting to another Mycelium address to verify everything works!
---
## Using Command-Line (Linux & Advanced Users)
For Linux users or those who prefer the command-line:
### Step 1: Start Mycelium
**Linux/macOS:**
```bash
sudo mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651
```
**Windows (as Administrator):**
```cmd
mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651
```
You should see output indicating Mycelium is starting and connecting to peers.
<div className="info-box">
### Step 2: Get Your IPv6 Address
### 🔐 Why sudo/Administrator?
Mycelium needs elevated privileges to create a network interface. This is standard for networking tools.
</div>
## Step 2: Get Your IPv6 Address
Open a **new terminal** (keep Mycelium running in the first one) and check your node info:
Open a **new terminal** and check your node info:
```bash
mycelium inspect --json
@@ -46,9 +86,9 @@ You'll see output like:
}
```
**Save your address** - this is your unique Mycelium IPv6 address that others will use to reach you.
**Save your address** - this is your unique Mycelium IPv6 address.
## Step 3: Test Connectivity
### Step 3: Test Connectivity
Ping one of the public peers to verify connectivity:
@@ -56,58 +96,17 @@ Ping one of the public peers to verify connectivity:
ping6 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907
```
If you see responses, congratulations! You're connected to the Mycelium network.
If you see responses, you're connected!
```
PING 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907(54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907) 56 data bytes
64 bytes from 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907: icmp_seq=1 ttl=64 time=28.5 ms
64 bytes from 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907: icmp_seq=2 ttl=64 time=27.8 ms
```
### Step 4: Keep It Running (Linux)
## Public Peers List
Connect to these stable public peers for reliable connectivity:
| Region | IPv4 | IPv6 | TCP/QUIC Port | Mycelium IP |
|--------|------|------|---------------|-------------|
| Germany | 188.40.132.242 | 2a01:4f8:221:1e0b::2 | 9651 | 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907 |
| Germany | 136.243.47.186 | 2a01:4f8:212:fa6::2 | 9651 | 40a:152c:b85b:9646:5b71:d03a:eb27:2462 |
| Belgium | 185.69.166.7 | 2a02:1802:5e:0:ec4:7aff:fe51:e80d | 9651 | 597:a4ef:806:b09:6650:cbbf:1b68:cc94 |
| Belgium | 185.69.166.8 | 2a02:1802:5e:0:ec4:7aff:fe51:e36b | 9651 | 549:8bce:fa45:e001:cbf8:f2e2:2da6:a67c |
| Finland | 65.21.231.58 | 2a01:4f9:6a:1dc5::2 | 9651 | 410:2778:53bf:6f41:af28:1b60:d7c0:707a |
| Finland | 65.109.18.113 | 2a01:4f9:5a:1042::2 | 9651 | 488:74ac:8a31:277b:9683:c8e:e14f:79a7 |
| US East | 209.159.146.190 | 2604:a00:50:17b:9e6b:ff:fe1f:e054 | 9651 | 4ab:a385:5a4e:ef8f:92e0:1605:7cb6:24b2 |
| US West | 5.78.122.16 | 2a01:4ff:1f0:8859::1 | 9651 | 4de:b695:3859:8234:d04c:5de6:8097:c27c |
| Singapore | 5.223.43.251 | 2a01:4ff:2f0:3621::1 | 9651 | 5eb:c711:f9ab:eb24:ff26:e392:a115:1c0e |
| India | 142.93.217.194 | 2400:6180:100:d0::841:2001 | 9651 | 445:465:fe81:1e2b:5420:a029:6b0:9f61 |
## Connect to Multiple Peers
For better reliability and performance, connect to multiple peers:
```bash
sudo mycelium --peers \
tcp://188.40.132.242:9651 \
quic://185.69.166.8:9651 \
tcp://185.69.166.7:9651 \
quic://65.21.231.58:9651
```
This creates redundant paths and improves network resilience.
## Keep Mycelium Running
Mycelium needs to stay running to maintain your network connection.
### Run in Background
**Linux/macOS:**
**Run in Background:**
```bash
# Using nohup
nohup sudo mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651 &
```
**Better: Use systemd (Linux):**
**Better: Use systemd:**
Create `/etc/systemd/system/mycelium.service`:
```ini
@@ -132,11 +131,38 @@ sudo systemctl start mycelium
sudo systemctl status mycelium
```
**Windows:**
- Use Task Scheduler to run at startup
- Or run in a Command Prompt window kept open
---
## Basic Usage Examples
## Public Peers List
Here are stable public peers you can connect to:
| Region | Address for App | Mycelium IP |
|--------|-----------------|-------------|
| Germany | tcp://188.40.132.242:9651 | 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907 |
| Germany | tcp://136.243.47.186:9651 | 40a:152c:b85b:9646:5b71:d03a:eb27:2462 |
| Belgium | tcp://185.69.166.7:9651 | 597:a4ef:806:b09:6650:cbbf:1b68:cc94 |
| Belgium | tcp://185.69.166.8:9651 | 549:8bce:fa45:e001:cbf8:f2e2:2da6:a67c |
| Finland | tcp://65.21.231.58:9651 | 410:2778:53bf:6f41:af28:1b60:d7c0:707a |
| Finland | tcp://65.109.18.113:9651 | 488:74ac:8a31:277b:9683:c8e:e14f:79a7 |
| US East | tcp://209.159.146.190:9651 | 4ab:a385:5a4e:ef8f:92e0:1605:7cb6:24b2 |
| US West | tcp://5.78.122.16:9651 | 4de:b695:3859:8234:d04c:5de6:8097:c27c |
| Singapore | tcp://5.223.43.251:9651 | 5eb:c711:f9ab:eb24:ff26:e392:a115:1c0e |
| India | tcp://142.93.217.194:9651 | 445:465:fe81:1e2b:5420:a029:6b0:9f61 |
**Using the App?** Just copy these addresses and paste them in the Peers section!
**Using Command-Line?** Add multiple peers for better reliability:
```bash
sudo mycelium --peers \
tcp://188.40.132.242:9651 \
tcp://185.69.166.8:9651 \
tcp://185.69.166.7:9651 \
tcp://65.21.231.58:9651
```
## What You Can Do Now
### SSH to Another Device
@@ -154,34 +180,44 @@ curl http://[5c4:c176:bf44:b2ab:5e7e:f6a:b7e2:11ca]:8080
Note: IPv6 addresses must be in brackets for URLs.
### Connect Two Locations
### Connect Multiple Devices
Run Mycelium on devices at both locations:
Run Mycelium on devices at different locations:
- They'll automatically find each other through the mesh
- Use their Mycelium IPs to communicate
- All traffic is encrypted end-to-end
### Access ThreeFold Grid
Deploy workloads on the ThreeFold Grid and connect to them using your Mycelium connection. Check the [ThreeFold Dashboard](https://dashboard.grid.tf) to deploy with Mycelium enabled.
## Troubleshooting
### Can't Connect to Peers
### App Not Connecting
**Using the app:**
1. **Restart the app** - Close and reopen
2. **Check internet** - Verify you're online
3. **Add more peers** - Use the Peers section to add public peers
4. **Check firewall** - Ensure the app isn't blocked
5. **Windows: Run as administrator**
### Command-Line Issues
**Can't Connect to Peers:**
1. **Check internet connection** - Verify you're online
2. **Firewall issues** - Mycelium should work behind NAT, but try temporarily disabling firewall
3. **IPv6 support** - Ensure IPv6 is enabled on your system
4. **Try different peers** - Some may be temporarily down
### Can't Ping Other Nodes
2. **Try different peers** - Some may be temporarily down
3. **Firewall issues** - Mycelium should work behind NAT, but check firewall settings
4. **IPv6 support** - Ensure IPv6 is enabled
**Can't Ping Other Nodes:**
1. **Wait a few minutes** - Network discovery takes time
2. **Check peer connections** - Ensure you're connected to peers
3. **Verify the address** - Make sure you're pinging a valid Mycelium address
4. **Check logs** - Look for errors in the Mycelium output
2. **Verify the address** - Make sure you're pinging a valid Mycelium address
3. **Check peer connections** - Ensure you're connected to peers
### Permission Errors
- **Linux/macOS**: Must run with `sudo`
- **Windows**: Must run Command Prompt as Administrator
- This is required to create the network interface
**Permission Errors (Linux):**
- Must run with `sudo` to create network interface
- Check executable permissions: `chmod +x /usr/local/bin/mycelium`
## What's Next?