Installation and Deployment
Flexible deployment options including Docker, Helm, and Tencent Cloud to fit organizations of any size.
π€ Deploy with Cherry Studio Agent
Self-hosted deployment requires installing the server side before you can log into the enterprise client. Use the Agent in Cherry Studio Community Edition to automate the deployment.
Steps:
-
Download and install Cherry Studio Community Edition
-
Open the client, go to Agents, and select or create an agent
-
Send the following prompt to the agent:
Following the guide at /docs/en/setup, install cherry-enterprise-deploy-skill, and help me deploy. -
Provide server information (IP, SSH credentials) when the agent prompts you to complete the deployment.
Skill package download: cherry-enterprise-deploy-skill.zip
For manual deployment, continue reading below to choose a deployment method.
π Before You Start
System Requirements
Hardware Requirements
- CPU: 2 cores or more
- Memory: 4GB RAM (8GB recommended)
- Storage: 20GB available space (adjust based on data volume)
- Network: Stable network connection
Software Requirements
- OS: Linux (Ubuntu 20.04+, CentOS 7+), macOS, Windows
- Container runtime: Docker 20.10+ (Docker deployment)
- Kubernetes: 1.19+ (Helm deployment)
- Database: PostgreSQL 12+
Preparation Checklist
Before deploying, make sure you have the following ready:
1. Base Environment
- Choose a deployment method (Docker / Kubernetes)
- Prepare servers or cloud instances
- Install required runtime dependencies
2. Database Configuration
- Choose PostgreSQL
- Prepare database connection details
- Create the database and user
3. Authentication Configuration (Optional)
- Decide whether to use SSO
- Prepare Casdoor configuration (if needed)
- Configure enterprise identity system integration
4. Network Configuration
- Determine service domain names
- Configure SSL certificates (production)
- Open required ports (3670 API, 3680 Admin)
π¦ Deployment Options
Choose the right deployment option based on your needs:
βοΈ Cloud App One-Click Deployment (Recommended)
Use cases:
- Quick onboarding with zero configuration
- Fast trials for small and mid-sized teams
- Users unfamiliar with ops
Advantages:
- One-click deployment, no technical barrier
- Automated network and security group configuration
- Includes database and admin panel
- Elastic cloud resource scaling
View the full cloud app deployment guide β
π³ Docker Deployment
Use cases:
- Quick trials and testing
- Small and mid-sized teams
- Single-node deployment
Advantages:
- Simple deployment, one command to start
- Environment isolation, easy maintenance
- Docker Compose orchestration supported
View the full Docker deployment guide β
βΈοΈ Kubernetes Helm Deployment
Use cases:
- Production environments for large organizations
- High availability and auto scaling
- Existing Kubernetes clusters
Advantages:
- Automated ops management
- Horizontal scaling
- Robust health checks and failover
View the full Helm deployment guide β
π Deployment Steps Overview
Step 1: Choose a Deployment Option
Select the deployment option that fits your needs.
Step 2: Configure the Database
- Install PostgreSQL
- Create the database and user
- Configure connection parameters
View the database configuration guide β
Step 3: Deploy the Application
Follow the steps for your chosen deployment method:
- Docker: start with docker-compose
- Kubernetes: install with Helm
Step 4: Configure Authentication (Optional)
If you need enterprise SSO:
- Deploy Casdoor
- Configure the application and organization
- Integrate with Cherry Studio
View the SSO configuration guide β
Step 5: Verify Deployment
- Check API health:
http://your-domain:3670/health - Access the admin console:
http://your-domain:3680 - Sign in with the default admin account
- Complete initial setup
A fresh self-hosted deployment initializes the admin account with username
adminand passwordsecret. If you are using cloud app deployment, use the admin account information shown on the app settings page, and change the password immediately after first sign-in.
Next Step
Choose your deployment option and begin installation:
- βοΈ Cloud app deployment (recommended) - One-click deployment, zero technical barrier
- π³ Docker deployment - Quick deployment with Docker
- βΈοΈ Helm deployment - Deploy on Kubernetes
- ποΈ Database configuration - Configure PostgreSQL