feat: Add comprehensive documentation structure with farming, mycelium, and cloud guides

2025-10-16 08:35:58 -04:00
parent 4f0a8eec6e
commit 98e904384b
23 changed files with 2980 additions and 0 deletions
--- a/docs/farming/buy-node.md
+++ b/docs/farming/buy-node.md
@@ -0,0 +1,183 @@
+---
+sidebar_position: 2
+---
+
+# Buy or Build Your Node
+
+You have two main paths to becoming a ThreeFold farmer: buying a pre-configured node or building your own from hardware you already have or source yourself.
+
+## Option 1: Buy a Pre-Built Node (Easiest)
+
+### Why Buy Pre-Built?
+
+✅ **Plug-and-play** - Arrives ready to farm  
+✅ **Vendor support** - Help when you need it  
+✅ **Optimized hardware** - Tested configurations  
+✅ **Warranty** - Peace of mind  
+✅ **Quick start** - Farming within hours
+
+### Where to Buy
+
+Several vendors offer certified ThreeFold nodes:
+
+<div className="info-box">
+
+**📦 Node Vendors**
+
+Check the official ThreeFold channels for current list of certified node providers:
+- [ThreeFold Shop](https://threefold.io) - Official vendor listings
+- [Telegram Community](https://t.me/threefoldfarmers) - Vendor recommendations
+- [Forum Marketplace](https://forum.threefold.io) - Community sales
+
+</div>
+
+### What to Look For
+
+When buying a pre-built node, consider:
+
+- **Capacity Size** - Storage, RAM, and CPU cores
+- **Power Efficiency** - Lower electricity costs
+- **Warranty & Support** - Vendor backing
+- **Price vs. ROI** - Balance cost with earning potential
+- **Shipping & Import Fees** - Total landed cost
+
+### Typical Node Configurations
+
+**Entry Level (~$500-1000)**
+- 4-8 CPU cores
+- 16GB RAM
+- 500GB-1TB SSD
+- Low power consumption (~50W)
+
+**Mid Range (~$1000-2500)**
+- 8-16 CPU cores
+- 32-64GB RAM
+- 1-2TB SSD
+- Balanced performance (~100W)
+
+**High Performance (~$2500+)**
+- 16+ CPU cores
+- 64-128GB+ RAM
+- 2TB+ SSD (multi-drive)
+- Maximum capacity (~150-200W)
+
+## Option 2: Build Your Own Node
+
+### Why Build Your Own?
+
+✅ **Lower cost** - Use existing hardware  
+✅ **Flexibility** - Choose your own specs  
+✅ **Learning experience** - Understand the system  
+✅ **Upgrade existing gear** - Repurpose hardware
+
+### Hardware Requirements
+
+**Minimum Configuration:**
+```
+CPU:     Any 64-bit processor (Intel/AMD)
+         Multi-core recommended (4+ cores)
+RAM:     8GB minimum (16GB+ recommended)
+Storage: 500GB SSD minimum (1TB+ recommended)
+         Additional HDDs for more capacity
+Network: Gigabit Ethernet (wired connection)
+Boot:    USB drive (16GB+) for Zero-OS
+```
+
+**Recommended Configuration:**
+```
+CPU:     Modern multi-core processor (8+ cores)
+RAM:     32GB+ for better capacity utilization
+Storage: 1TB+ NVMe SSD for high-performance
+         Additional SSDs or HDDs for capacity
+Network: Gigabit Ethernet (1Gbps+)
+Power:   Efficient PSU (80+ certified)
+```
+
+### Compatible Hardware
+
+**Processors:**
+- Intel Core i5/i7/i9 (6th gen or newer)
+- AMD Ryzen 5/7/9
+- Intel Xeon
+- AMD EPYC (for larger deployments)
+
+**Storage:**
+- Any SATA/NVMe SSD
+- HDDs for additional capacity
+- RAID controllers supported
+
+**Network:**
+- Standard Ethernet adapters
+- Wired connection strongly recommended
+
+### Where to Source Hardware
+
+- **Repurpose** - Old servers or workstations
+- **Consumer Market** - Build from PC components
+- **Used Enterprise** - eBay, server resellers
+- **Local Dealers** - Computer hardware stores
+
+<div className="info-box">
+
+### 💡 Pro Tip
+
+Old enterprise servers (Dell PowerEdge, HP ProLiant) can make excellent farming nodes at low cost. Check eBay and local liquidators.
+
+</div>
+
+## Cost Considerations
+
+### Initial Investment
+
+| Item | Pre-Built | DIY |
+|------|-----------|-----|
+| Hardware | $500-3000+ | $200-2000+ |
+| Setup Time | 1-2 hours | 2-8 hours |
+| Technical Skill | Minimal | Moderate |
+| Support | Vendor | Community |
+
+### Operating Costs
+
+**Monthly expenses to factor in:**
+
+- ⚡ **Electricity** - Varies by location and node size
+  - Small node (~50W): $5-15/month
+  - Medium node (~100W): $10-30/month
+  - Large node (~200W): $20-60/month
+
+- 🌐 **Internet** - Usually existing connection
+  - Recommend dedicated connection for serious farming
+  - Business-grade for maximum uptime
+
+- 🔧 **Maintenance** - Occasional hardware replacement
+  - Budget for failed drives, power supplies
+  - Usually minimal with quality hardware
+
+## Making Your Decision
+
+### Choose Pre-Built If:
+
+- 👍 You want the easiest path
+- 👍 You value vendor support
+- 👍 You prefer plug-and-play
+- 👍 Time is more valuable than cost savings
+
+### Choose DIY If:
+
+- 👍 You have existing hardware
+- 👍 You enjoy technical projects
+- 👍 You want to minimize costs
+- 👍 You're comfortable with system building
+
+## What's Next?
+
+Once you have your hardware (or know what you'll buy), move on to:
+
+**[Setup Your Node](/farming/setup)** - Configure and connect to the grid
+
+---
+
+:::tip Need Help Deciding?
+
+Ask the community! The [ThreeFold Telegram](https://t.me/threefoldfarmers) has experienced farmers who can help you choose the right option for your situation.
+:::
--- a/docs/farming/overview.md
+++ b/docs/farming/overview.md
@@ -0,0 +1,101 @@
+---
+sidebar_position: 1
+---
+
+# What is ThreeFold Farming?
+
+ThreeFold Farming lets you contribute to the decentralized internet while earning rewards for providing storage, compute, and network capacity.
+
+## How It Works
+
+As a **ThreeFold Farmer**, you:
+
+1. **Deploy a Node (3Node)** - Connect standard server hardware to the ThreeFold Grid
+2. **Run Zero-OS** - Our self-healing operating system manages everything automatically
+3. **Provide Capacity** - Your node offers storage, compute, and network resources
+4. **Earn Rewards** - Get compensated for capacity and utilization
+
+## Why Become a Farmer?
+
+### 🌱 Simple & Autonomous
+
+- Deploy once and let it run
+- Minimal maintenance required
+- Self-healing Zero-OS handles operations
+- No complex system administration needed
+
+### 💰 Multiple Revenue Streams
+
+- **Capacity Rewards** - Earn for available resources
+- **Utilization Rewards** - Earn when your capacity is used
+- **Growing Demand** - More workloads = more income potential
+
+### 🌍 Make an Impact
+
+- Support a decentralized internet infrastructure
+- Provide alternatives to centralized cloud providers
+- Contribute to digital sovereignty and data privacy
+- Build the peer-to-peer internet of the future
+
+## What You Need
+
+### Hardware Requirements
+
+**Minimum Specs:**
+- Modern server or workstation
+- Multi-core processor (4+ cores recommended)
+- 8GB+ RAM (16GB+ recommended)
+- 500GB+ SSD storage
+- Reliable network connection
+
+**OR Buy a Pre-Built Node:**
+- Various vendors offer ready-to-deploy 3Nodes
+- Plug-and-play solution for easy entry
+- Professional support available
+
+### Other Requirements
+
+- ⚡ Reliable power supply
+- 🌐 Stable internet connection (wired recommended)
+- 📍 Physical space for hardware
+- 🔧 Basic technical comfort (if building your own)
+
+## Getting Started
+
+Ready to become a farmer? Here's your path:
+
+1. **[Buy or Build a Node](/farming/buy-node)** - Choose your hardware option
+2. **[Set Up Your Node](/farming/setup)** - Get your 3Node connected to the grid
+3. **Monitor & Earn** - Track your node via the ThreeFold Dashboard
+
+<div className="info-box">
+
+### 💡 First Time?
+
+Start with a pre-built node from a trusted vendor. This gives you the easiest path to farming while you learn the ecosystem.
+
+</div>
+
+## The Farmer Journey
+
+ThreeFold farmers have been the backbone of the grid for years. You'll join a global community of:
+
+- Individual enthusiasts running nodes at home
+- Small businesses providing local capacity
+- Data center operators scaling infrastructure
+- Community initiatives building regional networks
+
+Every farmer plays a vital role in creating a truly decentralized internet.
+
+## Resources
+
+- **Dashboard**: [dashboard.grid.tf](https://dashboard.grid.tf) - Manage your farm
+- **Manual**: [manual.grid.tf/farmers](https://manual.grid.tf/farmers) - Detailed technical docs
+- **Community**: [t.me/threefoldfarmers](https://t.me/threefoldfarmers) - Get help from farmers
+- **Forum**: [forum.threefold.io](https://forum.threefold.io) - Discussions and updates
+
+---
+
+:::tip Next Step
+Ready to get your node? Check out **[Buy or Build a Node](/farming/buy-node)** to explore your options.
+:::
--- a/docs/farming/setup.md
+++ b/docs/farming/setup.md
@@ -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!
+:::