feat(deploy): 优化 Docker 部署体验，新增一键部署脚本
## 新增功能 - 新增 docker-compose.local.yml：使用本地目录存储数据，便于迁移和备份 - 新增 docker-deploy.sh：一键部署脚本，自动生成安全密钥（JWT_SECRET、TOTP_ENCRYPTION_KEY、POSTGRES_PASSWORD） - 新增 deploy/.gitignore：忽略运行时数据目录 ## 优化改进 - docker-compose.local.yml 包含 PGDATA 环境变量修复，解决 PostgreSQL 18 Alpine 数据丢失问题 - 脚本自动设置 .env 文件权限为 600，增强安全性 - 脚本显示生成的凭证，方便用户记录 ## 文档更新 - 更新 README.md（英文版）：新增"快速开始"章节，添加部署版本对比表 - 更新 README_CN.md（中文版）：同步英文版更新 - 更新 deploy/README.md：详细说明两种部署方式和迁移方法 ## 使用方式 一键部署： ```bash curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash docker-compose -f docker-compose.local.yml up -d ``` 轻松迁移： ```bash tar czf sub2api-complete.tar.gz deploy/ # 传输到新服务器后直接解压启动即可 ```
This commit is contained in:
shaw
171
deploy/docker-deploy.sh
Normal file
171
deploy/docker-deploy.sh
Normal file
@@ -0,0 +1,171 @@
|
||||
#!/bin/bash
|
||||
# =============================================================================
|
||||
# Sub2API Docker Deployment Preparation Script
|
||||
# =============================================================================
|
||||
# This script prepares deployment files for Sub2API:
|
||||
# - Downloads docker-compose.local.yml and .env.example
|
||||
# - Generates secure secrets (JWT_SECRET, TOTP_ENCRYPTION_KEY, POSTGRES_PASSWORD)
|
||||
# - Creates necessary data directories
|
||||
#
|
||||
# After running this script, you can start services with:
|
||||
# docker-compose -f docker-compose.local.yml up -d
|
||||
# =============================================================================
|
||||
|
||||
set -e
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# GitHub raw content base URL
|
||||
GITHUB_RAW_URL="https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy"
|
||||
|
||||
# Print colored message
|
||||
print_info() {
|
||||
echo -e "${BLUE}[INFO]${NC} $1"
|
||||
}
|
||||
|
||||
print_success() {
|
||||
echo -e "${GREEN}[SUCCESS]${NC} $1"
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}[WARNING]${NC} $1"
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}[ERROR]${NC} $1"
|
||||
}
|
||||
|
||||
# Generate random secret
|
||||
generate_secret() {
|
||||
openssl rand -hex 32
|
||||
}
|
||||
|
||||
# Check if command exists
|
||||
command_exists() {
|
||||
command -v "$1" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
# Main installation function
|
||||
main() {
|
||||
echo ""
|
||||
echo "=========================================="
|
||||
echo " Sub2API Deployment Preparation"
|
||||
echo "=========================================="
|
||||
echo ""
|
||||
|
||||
# Check if openssl is available
|
||||
if ! command_exists openssl; then
|
||||
print_error "openssl is not installed. Please install openssl first."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if deployment already exists
|
||||
if [ -f "docker-compose.local.yml" ] && [ -f ".env" ]; then
|
||||
print_warning "Deployment files already exist in current directory."
|
||||
read -p "Overwrite existing files? (y/N): " -r
|
||||
echo
|
||||
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
|
||||
print_info "Cancelled."
|
||||
exit 0
|
||||
fi
|
||||
fi
|
||||
|
||||
# Download docker-compose.local.yml
|
||||
print_info "Downloading docker-compose.local.yml..."
|
||||
if command_exists curl; then
|
||||
curl -sSL "${GITHUB_RAW_URL}/docker-compose.local.yml" -o docker-compose.local.yml
|
||||
elif command_exists wget; then
|
||||
wget -q "${GITHUB_RAW_URL}/docker-compose.local.yml" -O docker-compose.local.yml
|
||||
else
|
||||
print_error "Neither curl nor wget is installed. Please install one of them."
|
||||
exit 1
|
||||
fi
|
||||
print_success "Downloaded docker-compose.local.yml"
|
||||
|
||||
# Download .env.example
|
||||
print_info "Downloading .env.example..."
|
||||
if command_exists curl; then
|
||||
curl -sSL "${GITHUB_RAW_URL}/.env.example" -o .env.example
|
||||
else
|
||||
wget -q "${GITHUB_RAW_URL}/.env.example" -O .env.example
|
||||
fi
|
||||
print_success "Downloaded .env.example"
|
||||
|
||||
# Generate .env file with auto-generated secrets
|
||||
print_info "Generating secure secrets..."
|
||||
echo ""
|
||||
|
||||
# Generate secrets
|
||||
JWT_SECRET=$(generate_secret)
|
||||
TOTP_ENCRYPTION_KEY=$(generate_secret)
|
||||
POSTGRES_PASSWORD=$(generate_secret)
|
||||
|
||||
# Create .env from .env.example
|
||||
cp .env.example .env
|
||||
|
||||
# Update .env with generated secrets (cross-platform compatible)
|
||||
if sed --version >/dev/null 2>&1; then
|
||||
# GNU sed (Linux)
|
||||
sed -i "s/^JWT_SECRET=.*/JWT_SECRET=${JWT_SECRET}/" .env
|
||||
sed -i "s/^TOTP_ENCRYPTION_KEY=.*/TOTP_ENCRYPTION_KEY=${TOTP_ENCRYPTION_KEY}/" .env
|
||||
sed -i "s/^POSTGRES_PASSWORD=.*/POSTGRES_PASSWORD=${POSTGRES_PASSWORD}/" .env
|
||||
else
|
||||
# BSD sed (macOS)
|
||||
sed -i '' "s/^JWT_SECRET=.*/JWT_SECRET=${JWT_SECRET}/" .env
|
||||
sed -i '' "s/^TOTP_ENCRYPTION_KEY=.*/TOTP_ENCRYPTION_KEY=${TOTP_ENCRYPTION_KEY}/" .env
|
||||
sed -i '' "s/^POSTGRES_PASSWORD=.*/POSTGRES_PASSWORD=${POSTGRES_PASSWORD}/" .env
|
||||
fi
|
||||
|
||||
# Create data directories
|
||||
print_info "Creating data directories..."
|
||||
mkdir -p data postgres_data redis_data
|
||||
print_success "Created data directories"
|
||||
|
||||
# Set secure permissions for .env file (readable/writable only by owner)
|
||||
chmod 600 .env
|
||||
echo ""
|
||||
|
||||
# Display completion message
|
||||
echo "=========================================="
|
||||
echo " Preparation Complete!"
|
||||
echo "=========================================="
|
||||
echo ""
|
||||
echo "Generated secure credentials:"
|
||||
echo " POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}"
|
||||
echo " JWT_SECRET: ${JWT_SECRET}"
|
||||
echo " TOTP_ENCRYPTION_KEY: ${TOTP_ENCRYPTION_KEY}"
|
||||
echo ""
|
||||
print_warning "These credentials have been saved to .env file."
|
||||
print_warning "Please keep them secure and do not share publicly!"
|
||||
echo ""
|
||||
echo "Directory structure:"
|
||||
echo " docker-compose.local.yml - Docker Compose configuration"
|
||||
echo " .env - Environment variables (generated secrets)"
|
||||
echo " .env.example - Example template (for reference)"
|
||||
echo " data/ - Application data (will be created on first run)"
|
||||
echo " postgres_data/ - PostgreSQL data"
|
||||
echo " redis_data/ - Redis data"
|
||||
echo ""
|
||||
echo "Next steps:"
|
||||
echo " 1. (Optional) Edit .env to customize configuration"
|
||||
echo " 2. Start services:"
|
||||
echo " docker-compose -f docker-compose.local.yml up -d"
|
||||
echo ""
|
||||
echo " 3. View logs:"
|
||||
echo " docker-compose -f docker-compose.local.yml logs -f sub2api"
|
||||
echo ""
|
||||
echo " 4. Access Web UI:"
|
||||
echo " http://localhost:8080"
|
||||
echo ""
|
||||
print_info "If admin password is not set in .env, it will be auto-generated."
|
||||
print_info "Check logs for the generated admin password on first startup."
|
||||
echo ""
|
||||
}
|
||||
|
||||
# Run main function
|
||||
main "$@"
|
||||
Reference in New Issue
Block a user