Files
proxmox/docs/01-getting-started/README_START_HERE.md

2.5 KiB

🚀 Quick Start Guide

Your Proxmox workspace is fully configured and ready to use!

What's Configured

  • All prerequisites installed (Node.js, pnpm, Git)
  • Workspace setup complete
  • All dependencies installed
  • Proxmox connection configured
    • Host: 192.168.11.10 (ml110.sankofa.nexus)
    • User: root@pam
    • API Token: mcp-server
  • Claude Desktop configuration ready
  • MCP Server: 57 tools available

🎯 Get Started in 30 Seconds

Start the MCP Server

# Production mode
pnpm mcp:start

# Development mode (auto-reload on changes)
pnpm mcp:dev

Test the Connection

# Test basic operations
pnpm test:basic

# Or run connection test
./scripts/test-connection.sh

📚 What You Can Do

With the MCP server running, you can:

Basic Operations (Available Now)

  • List Proxmox nodes
  • List VMs and containers
  • View storage information
  • Check cluster status
  • List available templates
  • Get VM/container details

Advanced Operations (Requires PROXMOX_ALLOW_ELEVATED=true)

  • Create/delete VMs and containers
  • Start/stop/reboot VMs
  • Manage snapshots and backups
  • Configure disks and networks
  • And much more!

⚙️ Enable Advanced Features (Optional)

If you need to create or modify VMs:

  1. Edit ~/.env:

    nano ~/.env
    
  2. Change:

    PROXMOX_ALLOW_ELEVATED=false
    

    To:

    PROXMOX_ALLOW_ELEVATED=true
    

⚠️ Warning: This enables destructive operations. Only enable if needed.

📖 Documentation

🛠️ Useful Commands

# Verification
./scripts/verify-setup.sh        # Verify current setup
./scripts/test-connection.sh     # Test Proxmox connection

# MCP Server
pnpm mcp:start          # Start server
pnpm mcp:dev            # Development mode
pnpm test:basic         # Test operations

# Frontend
pnpm frontend:dev       # Start frontend dev server
pnpm frontend:build     # Build for production

🎉 You're All Set!

Everything is configured and ready. Just start the MCP server and begin managing your Proxmox infrastructure!


Quick Reference:

  • Configuration: ~/.env
  • MCP Server: mcp-proxmox/index.js
  • Documentation: See files above