Server Documentation
Complete guide for installing, configuring, and managing the SysManage server.
Overview
The SysManage server is a modern web application built with FastAPI (Python) backend and React (TypeScript) frontend. It provides a centralized platform for managing multiple systems through lightweight agents.
Server Components
- Backend API - FastAPI with async support, JWT authentication, and WebSocket communication
- Frontend UI - React with TypeScript, Material-UI components, and real-time updates
- Database - PostgreSQL with Alembic migrations and comprehensive data models
- WebSocket Engine - Real-time bidirectional communication with agents
- Security Layer - Enterprise-grade security with mTLS, RBAC, and comprehensive scanning
🚀 Installation
Step-by-step installation guide for setting up the SysManage server on your infrastructure.
- System requirements and prerequisites
- Docker and traditional installation methods
- Database setup and configuration
- SSL certificate configuration
🔐 Secure Installation
Revolutionary automated setup script that transforms your SysManage installation into an enterprise-grade security fortress with OpenBAO integration.
- Automated OpenBAO vault initialization in production mode
- Cross-platform privilege management and elevation
- Cryptographically secure admin user creation
- Enterprise security defaults and hardening
- Database migration and schema initialization
⚙️ Configuration
Comprehensive configuration options for customizing your SysManage deployment.
- Configuration file structure
- Database connection settings
- Security and authentication options
- WebSocket and API configuration
🏗️ Deployment
Production deployment strategies and best practices for scalable infrastructure.
- Production deployment checklist
- Load balancing and scaling
- Monitoring and logging setup
- Backup and disaster recovery
✨ Features
Detailed overview of all server features and capabilities.
- Host and agent management
- Package management across platforms
- Real-time monitoring and alerts
- User management and RBAC
📋 Reports & PDF Generation
Comprehensive reporting system with real-time HTML viewing and professional PDF generation.
- Host inventory and system reports
- User management and security reports
- Real-time HTML and PDF generation
- Internationalized report content
🧪 Testing
Comprehensive testing strategy including unit tests, integration tests, and E2E testing with Playwright.
- Unit and integration testing
- End-to-end testing with Playwright
- Test coverage and reporting
- CI/CD testing pipeline
🔧 Troubleshooting
Common issues, debugging techniques, and solutions for server problems.
- Common error messages and solutions
- Log analysis and debugging
- Performance optimization
- Database maintenance
🔐 Security
Security features, configuration, and best practices for secure deployments.
- Authentication and authorization
- Mutual TLS (mTLS) configuration
- Security scanning and monitoring
- Hardening guidelines