feat: Add comprehensive documentation structure with farming, mycelium, and cloud guides
This commit is contained in:
mik-tf
219
docs/mycelium-network/quick-start.md
Normal file
219
docs/mycelium-network/quick-start.md
Normal file
@@ -0,0 +1,219 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Quick Start
|
||||
|
||||
Get connected to the Mycelium network in under 5 minutes.
|
||||
|
||||
## Step 1: Connect to Public Peers
|
||||
|
||||
Start your Mycelium node and connect to the global network:
|
||||
|
||||
**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">
|
||||
|
||||
### 🔐 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:
|
||||
|
||||
```bash
|
||||
mycelium inspect --json
|
||||
```
|
||||
|
||||
You'll see output like:
|
||||
```json
|
||||
{
|
||||
"publicKey": "abd16194646defe7ad2318a0f0a69eb2e3fe939c3b0b51cf0bb88bb8028ecd1d",
|
||||
"address": "5c4:c176:bf44:b2ab:5e7e:f6a:b7e2:11ca"
|
||||
}
|
||||
```
|
||||
|
||||
**Save your address** - this is your unique Mycelium IPv6 address that others will use to reach you.
|
||||
|
||||
## Step 3: Test Connectivity
|
||||
|
||||
Ping one of the public peers to verify connectivity:
|
||||
|
||||
```bash
|
||||
ping6 54b:83ab:6cb5:7b38:44ae:cd14:53f3:a907
|
||||
```
|
||||
|
||||
If you see responses, congratulations! You're connected to the Mycelium network.
|
||||
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
## 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:**
|
||||
```bash
|
||||
# Using nohup
|
||||
nohup sudo mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651 &
|
||||
```
|
||||
|
||||
**Better: Use systemd (Linux):**
|
||||
|
||||
Create `/etc/systemd/system/mycelium.service`:
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Mycelium Network
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/usr/local/bin/mycelium --peers tcp://188.40.132.242:9651 quic://185.69.166.8:9651
|
||||
Restart=always
|
||||
RestartSec=10
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
Enable and start:
|
||||
```bash
|
||||
sudo systemctl enable mycelium
|
||||
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
|
||||
|
||||
### SSH to Another Device
|
||||
|
||||
If you have SSH running on another device with Mycelium:
|
||||
|
||||
```bash
|
||||
ssh user@5c4:c176:bf44:b2ab:5e7e:f6a:b7e2:11ca
|
||||
```
|
||||
|
||||
### Access a Web Service
|
||||
|
||||
```bash
|
||||
curl http://[5c4:c176:bf44:b2ab:5e7e:f6a:b7e2:11ca]:8080
|
||||
```
|
||||
|
||||
Note: IPv6 addresses must be in brackets for URLs.
|
||||
|
||||
### Connect Two Locations
|
||||
|
||||
Run Mycelium on devices at both locations:
|
||||
- They'll automatically find each other through the mesh
|
||||
- Use their Mycelium IPs to communicate
|
||||
- All traffic is encrypted end-to-end
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### 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
|
||||
|
||||
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
|
||||
|
||||
### Permission Errors
|
||||
|
||||
- **Linux/macOS**: Must run with `sudo`
|
||||
- **Windows**: Must run Command Prompt as Administrator
|
||||
- This is required to create the network interface
|
||||
|
||||
## What's Next?
|
||||
|
||||
Now that you're connected, explore what you can do:
|
||||
|
||||
### Use Cases
|
||||
|
||||
- **Remote Access**: Access your services from anywhere
|
||||
- **Connect Devices**: Link multiple locations securely
|
||||
- **ThreeFold Grid**: Access your grid deployments
|
||||
- **P2P Applications**: Build distributed systems
|
||||
|
||||
### Advanced Configuration
|
||||
|
||||
For more advanced setup options:
|
||||
- Custom port configuration
|
||||
- Private peer networks
|
||||
- SOCKS5 proxy setup
|
||||
- Advanced routing options
|
||||
|
||||
Check the [detailed Mycelium guide](https://threefoldtech.github.io/www_myceliumguide/) for more information.
|
||||
|
||||
## Resources
|
||||
|
||||
- **Full Documentation**: [Mycelium User Guide](https://threefoldtech.github.io/www_myceliumguide/)
|
||||
- **GitHub**: [github.com/threefoldtech/mycelium](https://github.com/threefoldtech/mycelium)
|
||||
- **Community**: [Telegram](https://t.me/threefoldfarmers)
|
||||
- **Forum**: [forum.threefold.io](https://forum.threefold.io)
|
||||
|
||||
---
|
||||
|
||||
:::tip Connected Successfully?
|
||||
|
||||
Great! You're now part of the global Mycelium network. Try deploying on **[Mycelium Cloud](/mycelium-cloud/overview)** to run workloads on the ThreeFold Grid.
|
||||
:::
|
||||
Reference in New Issue
Block a user