Skip to main content

5-Minute Node Provider Setup

Join the QuikDB network as a node provider and start earning rewards

What You'll Accomplish​

✅ Install the QuikDB node CLI
✅ Authenticate with your account
✅ List your node in the marketplace
✅ Start earning rewards

Time Required: 5 minutes
Prerequisites: Node.js 16+, system with adequate resources

Step 1: Install CLI (30 seconds)​

npm install -g quikdb-nodes

Verify installation:

quikdb-nodes --version

Step 2: Authenticate (1 minute)​

quikdb-nodes auth

You'll be prompted to:

  • Enter your authentication token (get this from your dashboard)
  • Specify your node endpoint (defaults to localhost:3001 for development)

Step 3: List Your Node (2 minutes)​

quikdb-nodes list

The CLI will:

  • Validate your system resources
  • Determine the best tier for your hardware
  • List your node in the marketplace
  • Start accepting workloads

Step 4: Maintain Your Listing (1 minute)​

Start the heartbeat service to keep your node active:

quikdb-nodes heartbeat --daemon

What's Next?​

  • Monitor your node status: quikdb-nodes status
  • Check your earnings in the dashboard
  • Upgrade your hardware to increase earnings

System Requirements​

Minimum (Basic Tier)​

  • 2+ CPU cores
  • 8+ GB RAM
  • 200+ GB storage
  • Stable internet connection
  • 4+ CPU cores
  • 16+ GB RAM
  • 500+ GB SSD storage
  • 100+ Mbps bandwidth

Hardware Requirements​

Basic Tier: 2+ CPU cores, 8+ GB RAM, 200+ GB storage
Standard Tier: 4+ CPU cores, 16+ GB RAM, 500+ GB SSD storage
Premium Tier: 8+ CPU cores, 32+ GB RAM, 1+ TB SSD storage

Validation Output​

✅ System Validation Complete

Hardware Assessment:
├── CPU: 8 cores (Intel i7) - STANDARD TIER
├── RAM: 32 GB - PREMIUM CAPABLE
├── Storage: 1 TB NVMe SSD - EXCELLENT
├── Network: 500 Mbps - HIGH PERFORMANCE
└── Uptime History: 99.2% - GOOD

Recommended Tier: STANDARD
Estimated Monthly Earnings: $250-400

Advanced Configuration (Optional)​

Custom Location​

# Specify your geographic location for better matching
quikdb-nodes list --location "US-West" --type compute

Specific Tier Selection​

# Force a specific tier if auto-detection isn't optimal
quikdb-nodes list --tier premium --type storage

Dry Run Validation​

# Test your configuration without actually listing
quikdb-nodes list --dry-run

What's Next?​

Monitor Your Node​

# Check node status anytime
quikdb-nodes status

# View detailed performance metrics  
quikdb-nodes monitor

# Check earnings summary
quikdb-nodes earnings

Join the Community​

  • Discord: Connect with other node providers
  • Dashboard: Monitor performance and earnings
  • Documentation: Learn advanced configurations

Optimize Your Setup​

  • Hardware Upgrades: Increase tier for higher earnings
  • Network Optimization: Improve bandwidth for better performance
  • Multi-Node Setup: Scale to multiple machines

Troubleshooting​

Installation Issues​

# If npm install fails, try:
sudo npm install -g quikdb-nodes

# Or use yarn:
yarn global add quikdb-nodes

Authentication Problems​

# Verify your token in the dashboard
# Check your internet connection
# Ensure token has correct permissions
quikdb-nodes auth --debug

System Validation Failures​

Common issues and solutions:

  • Insufficient RAM: Need at least 8GB for basic tier
  • Low Storage: Minimum 200GB required
  • Network Issues: Ensure stable internet connection

Success Indicators​

You'll know your setup is working when:

✅ Node appears in marketplace ✅ Heartbeat service running ✅ Status shows "ACTIVE" ✅ Earnings start accumulating

Ready to start earning? Your node is now part of the QuikDB network!

Need help? Join our Discord community or check the troubleshooting guide.