Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
- ADD_CHAIN138_TO_LEDGER_LIVE: Ledger form done; public code review repo bis-innovations/LedgerLive; init/push commands - CONTRACT_DEPLOYMENT_RUNBOOK: Chain 138 gas price 1 gwei, 36-addr check, TransactionMirror workaround - CONTRACT_*: AddressMapper, MirrorManager deployed 2026-02-12; 36-address on-chain check - NEXT_STEPS_FOR_YOU: Ledger done; steps completable now (no LAN); run-completable-tasks-from-anywhere - MASTER_INDEX, OPERATOR_OPTIONAL, SMART_CONTRACTS_INVENTORY_SIMPLE: updates - LEDGER_BLOCKCHAIN_INTEGRATION_COMPLETE: bis-innovations/LedgerLive reference Co-authored-by: Cursor <cursoragent@cursor.com>
120 lines
2.5 KiB
Markdown
120 lines
2.5 KiB
Markdown
# 🚀 Quick Start Guide
|
|
|
|
**Last Updated:** 2026-01-31
|
|
**Document Version:** 1.0
|
|
**Status:** Active Documentation
|
|
|
|
---
|
|
|
|
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
|
|
|
|
```bash
|
|
# Production mode
|
|
pnpm mcp:start
|
|
|
|
# Development mode (auto-reload on changes)
|
|
pnpm mcp:dev
|
|
```
|
|
|
|
### Test the Connection
|
|
|
|
```bash
|
|
# 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`:
|
|
```bash
|
|
nano ~/.env
|
|
```
|
|
|
|
2. Change:
|
|
```
|
|
PROXMOX_ALLOW_ELEVATED=false
|
|
```
|
|
|
|
To:
|
|
```
|
|
PROXMOX_ALLOW_ELEVATED=true
|
|
```
|
|
|
|
⚠️ **Warning**: This enables destructive operations. Only enable if needed.
|
|
|
|
## 📖 Documentation
|
|
|
|
- **Main README**: [README.md](README.md)
|
|
- **MCP Setup Guide**: [MCP_SETUP.md](../04-configuration/MCP_SETUP.md)
|
|
- **Prerequisites**: [PREREQUISITES.md](PREREQUISITES.md)
|
|
- **Documentation index**: [MASTER_INDEX.md](../MASTER_INDEX.md)
|
|
|
|
## 🛠️ Useful Commands
|
|
|
|
```bash
|
|
# 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
|
|
|