Use these guidelines to plan, install, configure, operate, and troubleshoot the private deployment of ShimoDocs Suite.
Note The commands, package names, versions, addresses, and resource values shown in the guide are for example purposes only, unless otherwise explicitly stated. Please use the values provided with your distribution and deployment environment.
Plan Your Deployment
- System Requirements
- Resource Planning
Install ShimoDocs Suite
- Quick Start
- Single-node Kubernetes Deployment
- High Availability Kubernetes Deployment
Connecting to External Middleware
- MySQL 8 Requirements
- Deployment with MySQL 8
- Dameng V8 Requirements
- Deployment with Dameng V8
- Object Storage Configuration
- Deploying with Object Storage
- Kafka Configuration
- Deploying with Kafka
- Redis Configuration
- Deploying with Redis
- MongoDB Configuration
- Deploying with MongoDB
Operations Platform
- Overview of Operations Platform
Manage ShimoDocs Suite
- License Management
- Tenant Management
- AI Configuration
- Suite User Management
- Brand Customization
- System Configuration
- Editor Configuration
Operating System Services
- Cluster Management
- Middleware Configuration
- Service Logs
- Real-time Logs
- System Upgrade
- Configuration Center
Using Operations and Maintenance Tools
- Static Resource Monitoring
- Middleware Detection
- Container Packet Capture
- Compatibility Testing
- General Tools
Using Middleware Tools
- RDB Tools
- Kafka Tools
- gRPC Tools
- Redis Tools
- MongoDB Tools
Configuration Control Panel
- Notification Channels
- Advanced Settings
Control Business Operations
- Transcoding Event Search
- File Information Search
- Collaboration Blocking
- Document Repair
Management Platform
- Platform User Management
- Audit Log
Troubleshooting and Maintenance
- Installation Troubleshooting
- Data Backup
- Monitoring Metrics Reference
- Collaborative Editing Events
- Incident Response SOP