Installation Guide¶
Deployment Methods¶
-
Docker Compose Deployment ⭐Recommended
Recommended deployment method with complete configuration:
-
Docker Deployment
Simple and quick single-node deployment method:
-
BT Panel Deployment
Visual deployment using BT Panel:
-
Cluster Deployment
The best choice for large-scale deployment:
-
Local Development Deployment
Suitable for developers and contributors:
Configuration & Maintenance¶
-
System Update
Learn how to update to the latest version:
-
Environment Variables
All configurable environment variables explained:
-
Configuration File
Detailed explanation of Docker Compose configuration file:
Deployment Notes¶
Recommended Choices
- Docker Compose deployment is strongly recommended for better configuration management and service orchestration
- Docker deployment can be used for quick testing, but not recommended for production environments
- Users familiar with BT Panel can choose BT Panel deployment
- For enterprise users, cluster deployment is recommended for better scalability
Notes
Before deployment, please ensure:
- All required base software is installed
- You are familiar with basic Linux and Docker commands
- The server meets the minimum requirements
- All required API keys are ready
Get Help
If you encounter problems during deployment:
- Check the FAQ
- Submit an issue on GitHub
- Join the community group for help