# Documentation Index Welcome to the ACC Server Manager documentation! This comprehensive guide covers all aspects of installation, configuration, usage, and development. ## 📚 Quick Navigation ### 🚀 Getting Started - **[Detailed README](DETAILED_README.md)** - Complete installation and setup guide - **[Configuration Guide](CONFIGURATION.md)** - Advanced configuration options - **[Deployment Guide](DEPLOYMENT.md)** - Production deployment instructions ### 🔒 Security & Authentication - **[Security Guide](SECURITY.md)** - Security features, best practices, and compliance - **[API Documentation](API.md)** - Complete API reference with authentication details ### 🔧 Development & Technical - **[Implementation Summary](IMPLEMENTATION_SUMMARY.md)** - Technical architecture overview - **[Logging System](LOGGING_IMPLEMENTATION_SUMMARY.md)** - Enhanced logging and error handling - **[Logging Usage Examples](LOGGING_USAGE_EXAMPLES.md)** - Practical logging implementation guide ### 📈 Migration & Upgrades - **[Migration Guide](MIGRATION_GUIDE.md)** - General migration procedures - **[UUID Migration Instructions](UUID_MIGRATION_INSTRUCTIONS.md)** - Database UUID migration guide ## 📋 Documentation Structure ### Core Documentation | Document | Purpose | Audience | |----------|---------|----------| | [Detailed README](DETAILED_README.md) | Complete setup and usage guide | All users | | [Security Guide](SECURITY.md) | Security features and best practices | Administrators, Developers | | [Configuration](CONFIGURATION.md) | Advanced configuration options | System administrators | | [API Documentation](API.md) | Complete API reference | Developers, Integrators | | [Deployment Guide](DEPLOYMENT.md) | Production deployment | DevOps, System administrators | ### Technical Documentation | Document | Purpose | Audience | |----------|---------|----------| | [Implementation Summary](IMPLEMENTATION_SUMMARY.md) | Technical architecture overview | Developers, Architects | | [Logging System](LOGGING_IMPLEMENTATION_SUMMARY.md) | Logging and error handling details | Developers | | [Logging Usage Examples](LOGGING_USAGE_EXAMPLES.md) | Practical logging examples | Developers | ### Migration Documentation | Document | Purpose | Audience | |----------|---------|----------| | [Migration Guide](MIGRATION_GUIDE.md) | General migration procedures | System administrators | | [UUID Migration Instructions](UUID_MIGRATION_INSTRUCTIONS.md) | Database UUID migration | Developers, DBAs | ## 🎯 Quick Access by Role ### 👤 End Users 1. Start with [Detailed README](DETAILED_README.md) for installation 2. Review [Configuration Guide](CONFIGURATION.md) for setup 3. Check [Security Guide](SECURITY.md) for security best practices ### 🔧 System Administrators 1. [Detailed README](DETAILED_README.md) - Installation and basic setup 2. [Security Guide](SECURITY.md) - Security configuration 3. [Configuration Guide](CONFIGURATION.md) - Advanced configuration 4. [Deployment Guide](DEPLOYMENT.md) - Production deployment 5. [Migration Guide](MIGRATION_GUIDE.md) - System migrations ### 💻 Developers 1. [Implementation Summary](IMPLEMENTATION_SUMMARY.md) - Architecture overview 2. [API Documentation](API.md) - API reference 3. [Logging System](LOGGING_IMPLEMENTATION_SUMMARY.md) - Logging architecture 4. [Logging Usage Examples](LOGGING_USAGE_EXAMPLES.md) - Implementation examples 5. [UUID Migration Instructions](UUID_MIGRATION_INSTRUCTIONS.md) - Database changes ### 🏢 DevOps Engineers 1. [Deployment Guide](DEPLOYMENT.md) - Production deployment 2. [Security Guide](SECURITY.md) - Security configuration 3. [Configuration Guide](CONFIGURATION.md) - Environment setup 4. [Migration Guide](MIGRATION_GUIDE.md) - System migrations ## 🔍 Feature Documentation ### Authentication & Security - JWT token-based authentication → [Security Guide](SECURITY.md) - Role-based access control → [Security Guide](SECURITY.md) - API authentication → [API Documentation](API.md) ### Server Management - Multi-server configuration → [Configuration Guide](CONFIGURATION.md) - Steam integration → [Detailed README](DETAILED_README.md) - Service management → [Deployment Guide](DEPLOYMENT.md) ### Monitoring & Logging - Centralized error handling → [Logging System](LOGGING_IMPLEMENTATION_SUMMARY.md) - Usage examples → [Logging Usage Examples](LOGGING_USAGE_EXAMPLES.md) - Performance monitoring → [Implementation Summary](IMPLEMENTATION_SUMMARY.md) ### Database & Migrations - Database schema → [Implementation Summary](IMPLEMENTATION_SUMMARY.md) - UUID migration → [UUID Migration Instructions](UUID_MIGRATION_INSTRUCTIONS.md) - General migrations → [Migration Guide](MIGRATION_GUIDE.md) ## 📝 Document Status | Document | Status | Last Updated | Version | |----------|--------|--------------|---------| | Detailed README | ✅ Complete | Current | 2.0 | | Security Guide | ✅ Complete | Current | 1.0 | | API Documentation | ✅ Complete | Current | 1.0 | | Configuration Guide | ✅ Complete | Current | 1.0 | | Deployment Guide | ✅ Complete | Current | 1.0 | | Implementation Summary | ✅ Complete | Current | 1.0 | | Logging System | ✅ Complete | Current | 2.0 | | Logging Usage Examples | ✅ Complete | Current | 2.0 | | Migration Guide | ✅ Complete | Current | 1.0 | | UUID Migration Instructions | ✅ Complete | Current | 1.0 | ## 🆘 Support & Help ### Common Issues - Installation problems → [Detailed README](DETAILED_README.md#troubleshooting) - Security configuration → [Security Guide](SECURITY.md) - API integration → [API Documentation](API.md) - Performance issues → [Logging System](LOGGING_IMPLEMENTATION_SUMMARY.md) ### Development Support - Architecture questions → [Implementation Summary](IMPLEMENTATION_SUMMARY.md) - Logging implementation → [Logging Usage Examples](LOGGING_USAGE_EXAMPLES.md) - Database migrations → [Migration Guide](MIGRATION_GUIDE.md) ### Community Resources - GitHub Issues for bug reports - GitHub Discussions for community support - API documentation at `/swagger/` endpoint ## 🔄 Documentation Updates This documentation is actively maintained and updated with each release. For the latest version, always refer to the documentation in the main branch. ### Contributing to Documentation 1. Follow the existing documentation structure 2. Use clear, concise language 3. Include practical examples 4. Update this index when adding new documents 5. Maintain cross-references between documents --- **Need immediate help?** Start with the [Detailed README](DETAILED_README.md) for installation and basic usage, or jump directly to the specific guide for your role above.