# Proxmox MCP Documentation
Welcome to the comprehensive documentation for Proxmox MCP Server. This documentation is organized by user journey and role to help you find exactly what you need.
## 🚀 Quick Navigation
| I want to... | Go to |
|--------------|-------|
| **Get started quickly** | [Getting Started](getting-started/README.md) |
| **Deploy to production** | [Installation Guide](getting-started/installation.md) |
| **Manage daily operations** | [Administration](administration/README.md) |
| **Integrate with systems** | [Integration](integration/README.md) |
| **Understand security** | [Security](security/README.md) |
| **Find API details** | [Reference](reference/README.md) |
| **Troubleshoot problems** | [Troubleshooting](administration/troubleshooting.md) |
## 📚 Documentation Sections
### [🎯 Getting Started](getting-started/README.md)
Perfect for new users who want to get Proxmox MCP running quickly.
- **Quick Start**: 10-minute setup guide
- **Installation**: Complete production deployment
- **First Steps**: Initial configuration and validation
### [🔧 Administration](administration/README.md)
Essential for system administrators managing Proxmox MCP in production.
- **Daily Operations**: Routine management tasks
- **Troubleshooting**: Problem diagnosis and resolution
- **Maintenance**: Updates, backups, and monitoring
### [🔌 Integration](integration/README.md)
For developers and integrators connecting Proxmox MCP to other systems.
- **Claude Code Setup**: Client configuration and usage
- **API Integration**: Direct API access and development
- **Enterprise Integration**: SSO, RBAC, and monitoring
### [🛡️ Security](security/README.md)
Critical for security teams and compliance officers.
- **Security Architecture**: Complete security model
- **Best Practices**: Operational security procedures
- **Compliance**: SOC 2, ISO 27001, NIST framework support
### [📖 Reference](reference/README.md)
Comprehensive technical reference for all features.
- **API Reference**: Complete endpoint documentation
- **Configuration**: All configuration options
- **Requirements**: System and network requirements
## 👥 Role-Based Quick Paths
### 🆕 First-Time Users
1. Start with [Quick Start Guide](getting-started/quick-start.md)
2. Follow [Installation Guide](getting-started/installation.md)
3. Configure [Claude Code Integration](integration/claude-code-setup.md)
### 🔧 System Administrators
1. Review [Security Architecture](security/security-guide.md)
2. Complete [Production Installation](getting-started/installation.md)
3. Set up [Daily Operations](administration/daily-operations.md)
4. Configure [Monitoring and Maintenance](administration/README.md)
### 👩💻 Developers & Integrators
1. Understand [API Architecture](integration/README.md)
2. Set up [Development Environment](../CONTRIBUTING.md#development-setup)
3. Review [API Reference](reference/README.md)
4. Explore [Integration Examples](integration/claude-code-setup.md)
### 🛡️ Security Teams
1. Study [Security Architecture](security/security-guide.md)
2. Review [Compliance Framework](security/compliance.md)
3. Validate [Security Controls](security/enhanced-sudoers.md)
4. Set up [Security Monitoring](security/best-practices.md)
## 📋 Documentation Standards
All documentation follows these principles:
- **User-first approach**: Written for end users, not developers
- **Step-by-step guidance**: Clear instructions with expected outputs
- **Copy-paste ready**: Commands you can use immediately
- **Cross-referenced**: Links to related information
- **Tested procedures**: All instructions verified on real systems
## 🔄 Keeping Documentation Updated
This documentation is actively maintained alongside the codebase. If you find:
- **Outdated information**: Please report it as an issue
- **Missing details**: Suggest improvements via discussions
- **Errors or typos**: Submit a pull request with fixes
## 🆘 Getting Help
- **Documentation Issues**: Report problems with docs
- **Feature Questions**: Use GitHub Discussions
- **Security Concerns**: Email security@your-domain.com
- **General Support**: Check [Troubleshooting](administration/troubleshooting.md)
---
**💡 Tip**: Bookmark this page as your documentation home base. All guides are designed to be self-contained but cross-reference related topics when helpful.
