Installation Guide
Installation Guide
Deployment Methods
<div class="grid cards" markdown>
-
:material-docker:{ .twemoji }
Docker Compose Deployment ⭐Recommended
The recommended method for single-machine deployment, providing complete configuration:
-
:material-docker:{ .twemoji }
Docker Deployment
A simple and fast method for single-machine deployment:
-
:material-server:{ .twemoji }
1Panel Panel Deployment
Use the 1Panel panel for visual deployment:
-
:material-server:{ .twemoji }
BaoTa Panel Deployment
Use the BaoTa panel for visual deployment:
-
:material-server-network:{ .twemoji }
Cluster Deployment
The best choice for large-scale deployment:
-
:material-code-braces:{ .twemoji }
Local Development Deployment
Suitable for developers and contributors:
</div>
Configuration and Maintenance
<div class="grid cards" markdown>
-
:material-update:{ .twemoji }
System Update
Learn how to update to the latest version:
-
:material-variable:{ .twemoji }
Environment Variables
Descriptions of all configurable environment variables:
-
:material-file-cog:{ .twemoji }
Configuration File
Detailed explanation of the Docker Compose configuration file:
</div>
Deployment Notes
[!TIP] Selection Advice
- Docker Compose deployment is recommended, offering better configuration management and service orchestration
- Docker deployment can be used for quick testing, but is not recommended for production environments
- Users familiar with the BaoTa Panel can choose BaoTa Panel deployment
- Enterprise users are advised to use cluster deployment for better scalability
[!WARNING] Precautions Before deployment, please ensure:
- Required basic software has been installed
- Basic Linux and Docker commands are understood
- Server configuration meets minimum requirements
- Necessary API keys have been prepared
[!INFO] Getting Help If you encounter issues during the deployment process:
- Check the Frequently Asked Questions
- Submit an issue on GitHub
- Join the QQ Communication Group for assistance
How is this guide?