feat: Add comprehensive documentation structure with farming, mycelium, and cloud guides
This commit is contained in:
229
docs/farming/setup.md
Normal file
229
docs/farming/setup.md
Normal file
@@ -0,0 +1,229 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Set Up Your Node
|
||||
|
||||
This guide walks you through the basic steps to get your 3Node connected to the ThreeFold Grid and start farming.
|
||||
|
||||
## Overview
|
||||
|
||||
Setting up a node involves:
|
||||
|
||||
1. Creating a ThreeFold account
|
||||
2. Creating a farm on the dashboard
|
||||
3. Downloading and booting Zero-OS
|
||||
4. Verifying your node is online
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin:
|
||||
|
||||
- ✅ Hardware ready (purchased or built)
|
||||
- ✅ Reliable network connection (wired Ethernet)
|
||||
- ✅ Power supply connected
|
||||
- ✅ USB drive (16GB+) for Zero-OS boot image
|
||||
|
||||
## Step 1: Create Your ThreeFold Account
|
||||
|
||||
### Get a Wallet
|
||||
|
||||
You'll need a ThreeFold Connect wallet:
|
||||
|
||||
1. Download **ThreeFold Connect** app:
|
||||
- iOS: [App Store](https://apps.apple.com)
|
||||
- Android: [Google Play](https://play.google.com)
|
||||
|
||||
2. Create a new account
|
||||
3. **Save your seed phrase securely** - This is critical!
|
||||
4. Complete the setup wizard
|
||||
|
||||
<div className="info-box">
|
||||
|
||||
### 🔐 Security Warning
|
||||
|
||||
Your seed phrase is the **only** way to recover your account. Write it down and store it safely offline. Never share it with anyone.
|
||||
|
||||
</div>
|
||||
|
||||
## Step 2: Create Your Farm
|
||||
|
||||
### Access the Dashboard
|
||||
|
||||
1. Go to [dashboard.grid.tf](https://dashboard.grid.tf)
|
||||
2. Connect with your ThreeFold Connect wallet
|
||||
3. Select the appropriate network (usually **mainnet**)
|
||||
|
||||
### Register Your Farm
|
||||
|
||||
1. Navigate to **Farms** section
|
||||
2. Click **Create Farm**
|
||||
3. Fill in farm details:
|
||||
- **Farm Name** - Choose a unique name
|
||||
- **Pricing Policy** - Usually default is fine
|
||||
- **Certification** - Select appropriate level
|
||||
4. Save your farm
|
||||
|
||||
You'll receive a **Farm ID** - save this number, you'll need it for the next step.
|
||||
|
||||
## Step 3: Download Zero-OS
|
||||
|
||||
### Create Boot Image
|
||||
|
||||
1. In the dashboard, go to your farm
|
||||
2. Click **Bootstrap Image**
|
||||
3. Select options:
|
||||
- **Network**: Choose your network interface
|
||||
- **Format**: USB or ISO (USB for most cases)
|
||||
4. Download the image
|
||||
|
||||
The image is customized with your Farm ID, so your node will automatically connect to your farm.
|
||||
|
||||
### Write to USB Drive
|
||||
|
||||
**On Linux/Mac:**
|
||||
```bash
|
||||
# Find your USB device
|
||||
lsblk
|
||||
|
||||
# Write the image (replace /dev/sdX with your USB device)
|
||||
sudo dd if=zero-os-farm-XXXX.img of=/dev/sdX bs=4M status=progress
|
||||
sync
|
||||
```
|
||||
|
||||
**On Windows:**
|
||||
- Use [Rufus](https://rufus.ie/) or [balenaEtcher](https://www.balena.io/etcher/)
|
||||
- Select the downloaded image
|
||||
- Select your USB drive
|
||||
- Click Write/Flash
|
||||
|
||||
<div className="info-box">
|
||||
|
||||
### ⚠️ Warning
|
||||
|
||||
Double-check you're writing to the correct device. The dd command will overwrite whatever device you specify!
|
||||
|
||||
</div>
|
||||
|
||||
## Step 4: Boot Your Node
|
||||
|
||||
### BIOS/UEFI Configuration
|
||||
|
||||
Before first boot, configure your node's BIOS:
|
||||
|
||||
1. **Boot Order**
|
||||
- Set USB as first boot device
|
||||
- Enable boot from USB
|
||||
|
||||
2. **Virtualization**
|
||||
- Enable Intel VT-x / AMD-V
|
||||
- Enable VT-d / AMD-Vi (if available)
|
||||
|
||||
3. **Network Boot** (optional)
|
||||
- Can enable PXE for future use
|
||||
- Not required for USB boot
|
||||
|
||||
4. **Power Management**
|
||||
- Disable deep sleep modes
|
||||
- Enable "restore on AC/power loss" for automatic recovery
|
||||
|
||||
### First Boot
|
||||
|
||||
1. Insert the USB drive with Zero-OS
|
||||
2. Power on the node
|
||||
3. Select USB boot (or it should auto-boot)
|
||||
4. Zero-OS will start loading
|
||||
|
||||
**What to expect:**
|
||||
- Initial boot takes 2-5 minutes
|
||||
- Node will download latest Zero-OS version
|
||||
- Screen will show node information
|
||||
- After setup, displays Farm ID and Node ID
|
||||
|
||||
## Step 5: Verify Your Node
|
||||
|
||||
### Check Dashboard
|
||||
|
||||
1. Go to [dashboard.grid.tf](https://dashboard.grid.tf)
|
||||
2. Navigate to your Farm
|
||||
3. You should see your node listed
|
||||
4. Check status shows **Online**
|
||||
|
||||
### Node Information
|
||||
|
||||
Your node displays:
|
||||
- **Node ID** - Unique identifier
|
||||
- **Farm ID** - Your farm
|
||||
- **Status** - Should be "Up"
|
||||
- **Resources** - CPU, RAM, Storage capacity
|
||||
- **Uptime** - Connection time
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
**Node not appearing?**
|
||||
- Wait 5-10 minutes for initial sync
|
||||
- Check network cable connection
|
||||
- Verify farm ID on boot screen matches dashboard
|
||||
- Check firewall isn't blocking connections
|
||||
|
||||
**Node shows offline?**
|
||||
- Check power and network
|
||||
- Verify BIOS settings
|
||||
- Ensure USB drive is properly inserted
|
||||
- Check Zero-OS boot logs on screen
|
||||
|
||||
## Step 6: Monitor & Maintain
|
||||
|
||||
### Regular Monitoring
|
||||
|
||||
Check your node periodically via the dashboard:
|
||||
- Uptime percentage
|
||||
- Capacity utilization
|
||||
- Rewards accumulation
|
||||
- Network connectivity
|
||||
|
||||
### Maintenance Tasks
|
||||
|
||||
**Monthly:**
|
||||
- Verify node is online
|
||||
- Check reward accumulation
|
||||
- Monitor uptime statistics
|
||||
|
||||
**As Needed:**
|
||||
- Update Zero-OS (usually automatic)
|
||||
- Replace failed drives
|
||||
- Clean dust from hardware
|
||||
- Verify network connectivity
|
||||
|
||||
### Maximize Uptime
|
||||
|
||||
For best rewards:
|
||||
- Keep node powered 24/7
|
||||
- Use reliable network connection
|
||||
- Monitor for hardware issues
|
||||
- Join farmer community for alerts
|
||||
|
||||
## What's Next?
|
||||
|
||||
🎉 **Congratulations!** Your node is now farming on the ThreeFold Grid.
|
||||
|
||||
### Advanced Topics
|
||||
|
||||
For more details, check the advanced manual:
|
||||
- Multiple node management
|
||||
- Advanced networking setup
|
||||
- GPU farming
|
||||
- Farmerbot automation
|
||||
|
||||
**Resources:**
|
||||
- [Manual](https://manual.grid.tf/farmers) - Comprehensive farming guide
|
||||
- [Dashboard](https://dashboard.grid.tf) - Manage your farm
|
||||
- [Telegram](https://t.me/threefoldfarmers) - Community support
|
||||
- [Forum](https://forum.threefold.io) - Discussions and updates
|
||||
|
||||
---
|
||||
|
||||
:::tip Growing Your Farm
|
||||
|
||||
Once you're comfortable with one node, you can add more nodes to your farm to increase capacity and earning potential!
|
||||
:::
|
||||
Reference in New Issue
Block a user