Documentation
Deploy ShimoDocs
in your own cloud.
55 official guides covering planning, Kubernetes installation, middleware integration, day-to-day operations, AI configuration, backup and incident response — written for the people who run the suite, not for a sales conversation.
Overview
- ShimoDocs Suite Deployment and OperationsPlan, install, configure, operate and troubleshoot a private ShimoDocs Suite deployment, from system requirements through to incident response.
Getting started
- High Availability Kubernetes DeploymentBuild a resilient ShimoDocs cluster: node topology, minimum server specifications, ACCESS_DOMAIN configuration and high-availability verification.
- Quick StartInstall ShimoDocs Suite for the first time: prepare the installer and release package, check the environment and verify the deployment after it completes.
- Resource PlanningSize a ShimoDocs deployment: application node requirements, middleware baselines and object storage planning for single-node and clustered installs.
- Single-Node Kubernetes DeploymentDeploy an integrated single-node ShimoDocs Suite environment on Kubernetes, and retain the acceptance materials your audit or handover will ask for.
- System RequirementsSupported server resources, network access and deployment prerequisites for installing ShimoDocs Suite in your own private cloud infrastructure.
Middleware
Dameng
- Deployment with Dameng V8After configuration, the installer will check database login, network connectivity, and table creation permissions.
- Dameng V8 RequirementsPlan a Dameng DM8 deployment for ShimoDocs Suite: the server specification, operating system, parameter and network requirements the database must meet.
Kafka
- Deploying with KafkaAfter the configuration is complete, the installer will check Kafka's network connectivity and permissions for creating topics.
- Kafka ConfigurationComplete the Kafka integration for a self-hosted ShimoDocs Suite deployment: the ports, topics and connection settings the message queue has to expose.
MongoDB
- Deploying with MongoDBOnce the configuration is complete, the installer will check the MongoDB network connection, connection, and authentication permissions.
- MongoDB ConfigurationFinish connecting ShimoDocs Suite to an external MongoDB: the network access, credentials and document database settings the deployment expects.
MySQL 8
- Deployment with MySQL 8Prepare and connect MySQL 8 as the relational dependency for a self-hosted ShimoDocs Suite deployment, including requirements and connection settings.
- MySQL 8 RequirementsSupport master-slave high availability switching Character set: utf8mb4 Time zone: Asia/Shanghai or UTC Connections: maxconnections ≥ 1000 Connection user:...
Object storage
- Deploying with Object StorageSet up object storage for ShimoDocs Suite document files, including bucket configuration, credentials and how the deployment consumes the endpoint.
- Object Storage ConfigurationOnly object storage fully compatible with the S3 protocol is supported. Huawei Cloud OBS, Alibaba Cloud OSS, Tencent Cloud COS, and AWS S3 are recommended.
Redis
- Deploying with RedisConfigure Redis for a ShimoDocs Suite deployment: the caching layer the collaboration services depend on, and how to wire it into the installer.
- Redis ConfigurationShimoDocs uses external Redis, which is usually applied in core scenarios such as session management, distributed locks, rate-limiting counters, and message...
Operations platform
- Operations Platform OverviewMap the ShimoDocs operations platform: suite administration for licences, tenants, users, brands and AI, plus the system services used in day-to-day ops.
Suite administration
- AI ConfigurationConfigure the AI capability inside a self-hosted ShimoDocs Suite deployment, including the model endpoint your organisation has approved.
- Brand CustomizationBrand customization is used to unify the brand identity and interface style of ShimoDocs Suite.
- License ManagementLicense management is used to obtain the server machine code for ShimoDocs Suite, create and issue licenses, and view the current license status, license...
- Tenant ManagementManage tenants in the ShimoDocs Suite operations platform: review system-wide totals and adjust the organisational boundaries each tenant operates within.
- Suite User ManagementUser management is used to view users in each tenant of ShimoDocs Suite and to enable or disable user accounts in bulk.
Configuration
- Editor ConfigurationYou can follow the steps in this document to locate configuration items, modify feature switches or quotas, verify whether they take effect, and restore the...
- System ConfigurationConfigure system-wide settings in the ShimoDocs Suite operations platform, for administrators and implementers setting the platform up for the first time.
Business control
- Collaboration BlockingWhen Kafka experiences a backlog, and it is confirmed that the abnormal backlog is caused by a certain file, you can use this disable feature to prohibit...
- Document RepairSymptoms of file corruption include documents failing to open properly, error pop-ups during loading, and inability to display content.
- File Information SearchFile information query is used to search for basic records of files in the system based on internal file GUID or client-side file ID, making it easy to...
- Transcoding Event SearchThe transcoding event query function is used to quickly view recent transcoding events on the MDP backend, helping to locate and troubleshoot issues during...
Control panel
- Advanced SettingsEdit the system custom pd-config as YAML from the ShimoDocs control panel, for advanced parameters and bulk configuration changes across a deployment.
- Notification ChannelsNotification channels are used to centrally manage how system alert messages are received, allowing middleware checks and other features to send failure and...
Middleware tools
- gRPC ToolUse the gRPC tool in the ShimoDocs operations platform to inspect services across three target modes, from selecting an endpoint to reading the response.
- Kafka ToolThe Kafka tool allows users to view the cluster status, topics, messages, consumer groups, and partition information in Kafka through the Redpanda console.
- MongoDB ToolsMongoDB is used to view MongoDB databases, collections, and document contents in the operations platform.
- RDB ToolQuery relational databases from the ShimoDocs operations platform: open a connection, pick a table, run SQL and read the result set without leaving the console.
- Redis ToolInspect Redis from the ShimoDocs operations platform: search keys on the left, then read the value, type and TTL of the selected key on the right.
Service operations
- Cluster ManagementThe cluster management module is a console used for operating the Kubernetes cluster of the MDP and customer interface platform, targeting three scenarios:...
- Configuration CenterView and modify application configuration for each ShimoDocs service, comparing the factory template against the values your deployment is running.
- Middleware ConfigurationMiddleware Configuration is a page in the MDP Operations Platform used to integrate with various storage and middleware in the client environment,...
- Real-Time LogsStream service logs from across the Kubernetes cluster to locate ShimoDocs service anomalies, failed requests and slow dependencies as they happen.
- Service LogsThe service logs feature is a Kibana-like log retrieval platform that can collect logs from various Pods and provides log search, query, and ratio analysis...
- System UpgradeUpload and apply a new ShimoDocs Suite installation package, with the pre-upgrade compatibility checks the operations platform runs before it starts.
System management
- Audit LogOperation logs are used to view and track user management operations in the system, helping with troubleshooting, security audits, and change tracking.
- Platform User ManagementSystem user management is used to maintain user accounts in the admin backend, including creating users, editing basic information, resetting passwords,...
Toolset
- Compatibility TestingAfter clicking "Fill Content Bucket," the bucket can automatically switch to file-contents.
- Container Packet CaptureCapture network traffic from running Pods to diagnose ShimoDocs connection failures, request timeouts and DNS problems inside the Kubernetes cluster.
- General ToolsThe General Tools page includes 7 commonly used functions: JSON formatting, format conversion, JWT decoding, timestamp conversion, machine time check, QR...
- Middleware CheckMiddleware check is used to verify whether system dependencies MySQL, Redis, Elasticsearch, S3, MongoDB, and Kafka can connect and read/write properly,...
- Static Resource MonitoringStatic resource monitoring is used to check the JS and CSS resources referenced by web pages, helping you understand the access status of resources,...
Troubleshooting and maintenance
- Collaborative Editing IncidentInvestigate collaborative editing symptoms in ShimoDocs Suite, from edit-link failures through node pressure to the middleware dependencies behind them.
- Data BackupValidate backup targets and back up the databases, object storage and configuration of a self-hosted ShimoDocs Suite deployment before you need a restore.
- Incident Response SOPA self-hosted incident response procedure for ShimoDocs Suite: gather evidence, contain impact, trace dependencies and verify recovery end to end.
- Installation TroubleshootingDiagnose failed ShimoDocs Suite installations: time synchronisation, data disk paths, dependency failures and installer access problems.
- Monitoring Metrics ReferenceRead the key service, node and middleware signals during a ShimoDocs Suite incident, and know which metric tells you which dependency is failing.