Getting Started
🎯 Choose Your Deployment Method¶
-
Docker Single-Container Deployment
Deploy New API quickly with a single Docker image – perfect for personal or small-scale scenarios.
-
Docker Compose Deployment
Orchestrate multiple services with Docker Compose – ideal for production or setups requiring MySQL, Redis, etc.
-
BT Panel Deployment
Deploy via the BT Panel GUI – great for users who prefer not to use the command line.
-
Cluster Deployment Mode
Multi-node distributed deployment for high availability, load balancing and horizontal scaling – designed for large-scale or enterprise scenarios.
-
Local Development Environment
Intended for contributors and secondary development, offering a full local setup guide.
📚 Explore Our Documentation¶
-
Wiki
Explore the project introduction, feature overview, technical architecture and roadmap.
-
User Guide
Detailed usage instructions and best practices.
-
API Reference
Comprehensive API descriptions and usage examples.
-
Help & Support
FAQs and community discussion.