mirror of
https://github.com/patdelphi/suanming.git
synced 2026-02-27 21:23:12 +08:00
feat: Add Docker deployment support
- Updated Dockerfile to use npm instead of pnpm - Added .dockerignore for optimized builds - Created docker-compose.yml for easy deployment - Added comprehensive Docker deployment guide - Configured health checks and data persistence - Ready for containerized deployment
This commit is contained in:
118
.dockerignore
Normal file
118
.dockerignore
Normal file
@@ -0,0 +1,118 @@
|
||||
# Node modules
|
||||
node_modules
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# Build output (will be built inside container)
|
||||
dist
|
||||
|
||||
# Development files
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
# IDE files
|
||||
.vscode
|
||||
.idea
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# OS files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Git
|
||||
.git
|
||||
.gitignore
|
||||
|
||||
# Documentation
|
||||
*.md
|
||||
README*
|
||||
CHANGELOG*
|
||||
LICENSE
|
||||
docs/
|
||||
|
||||
# Test files
|
||||
tests/
|
||||
*.test.js
|
||||
*.test.ts
|
||||
*.spec.js
|
||||
*.spec.ts
|
||||
|
||||
# Development tools
|
||||
.eslintrc*
|
||||
.prettierrc*
|
||||
tailwind.config.js
|
||||
vite.config.ts
|
||||
tsconfig*.json
|
||||
components.json
|
||||
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage
|
||||
|
||||
# Dependency directories
|
||||
jspm_packages/
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
.yarn-integrity
|
||||
|
||||
# parcel-bundler cache (https://parceljs.org/)
|
||||
.cache
|
||||
.parcel-cache
|
||||
|
||||
# next.js build output
|
||||
.next
|
||||
|
||||
# nuxt.js build output
|
||||
.nuxt
|
||||
|
||||
# vuepress build output
|
||||
.vuepress/dist
|
||||
|
||||
# Serverless directories
|
||||
.serverless
|
||||
|
||||
# FuseBox cache
|
||||
.fusebox/
|
||||
|
||||
# DynamoDB Local files
|
||||
.dynamodb/
|
||||
|
||||
# Database files (will be created in container)
|
||||
*.db
|
||||
*.sqlite
|
||||
*.sqlite3
|
||||
data/
|
||||
|
||||
# Debug files
|
||||
debug-*.txt
|
||||
debug-*.cjs
|
||||
|
||||
# Deployment files
|
||||
.koyeb/
|
||||
Dockerfile*
|
||||
docker-compose*.yml
|
||||
.dockerignore
|
||||
334
DOCKER_DEPLOYMENT.md
Normal file
334
DOCKER_DEPLOYMENT.md
Normal file
@@ -0,0 +1,334 @@
|
||||
# Docker 部署指南
|
||||
|
||||
本指南将帮助您使用 Docker 部署神机阁项目。
|
||||
|
||||
## 🐳 Docker 部署优势
|
||||
|
||||
- **环境一致性**: 确保开发、测试、生产环境完全一致
|
||||
- **快速部署**: 一键启动整个应用栈
|
||||
- **资源隔离**: 容器化运行,避免环境冲突
|
||||
- **易于扩展**: 支持水平扩展和负载均衡
|
||||
- **版本管理**: 支持镜像版本控制和回滚
|
||||
|
||||
## 📋 前置要求
|
||||
|
||||
确保您的系统已安装:
|
||||
- [Docker](https://docs.docker.com/get-docker/) (版本 20.10+)
|
||||
- [Docker Compose](https://docs.docker.com/compose/install/) (版本 2.0+)
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 方法一:使用 Docker Compose(推荐)
|
||||
|
||||
1. **克隆项目**
|
||||
```bash
|
||||
git clone https://github.com/your-username/suanming.git
|
||||
cd suanming
|
||||
```
|
||||
|
||||
2. **配置环境变量**
|
||||
```bash
|
||||
# 复制环境变量模板
|
||||
cp .env.example .env
|
||||
|
||||
# 编辑环境变量(重要:修改 JWT_SECRET)
|
||||
nano .env
|
||||
```
|
||||
|
||||
3. **启动应用**
|
||||
```bash
|
||||
# 构建并启动
|
||||
docker-compose up -d
|
||||
|
||||
# 查看日志
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
4. **访问应用**
|
||||
- 应用地址: http://localhost:8000
|
||||
- API 健康检查: http://localhost:8000/api/health
|
||||
|
||||
### 方法二:使用 Docker 命令
|
||||
|
||||
1. **构建镜像**
|
||||
```bash
|
||||
docker build -t suanming-app .
|
||||
```
|
||||
|
||||
2. **运行容器**
|
||||
```bash
|
||||
docker run -d \
|
||||
--name suanming-app \
|
||||
-p 8000:8000 \
|
||||
-e NODE_ENV=production \
|
||||
-e JWT_SECRET=your-super-secret-jwt-key \
|
||||
-v suanming-data:/app/data \
|
||||
suanming-app
|
||||
```
|
||||
|
||||
## 🔧 配置说明
|
||||
|
||||
### 环境变量
|
||||
|
||||
| 变量名 | 描述 | 默认值 | 必需 |
|
||||
|--------|------|--------|------|
|
||||
| `NODE_ENV` | 运行环境 | `production` | 是 |
|
||||
| `PORT` | 应用端口 | `8000` | 是 |
|
||||
| `JWT_SECRET` | JWT 密钥 | - | **是** |
|
||||
|
||||
### 数据持久化
|
||||
|
||||
应用使用 SQLite 数据库,数据存储在 `/app/data` 目录:
|
||||
- **Docker Compose**: 自动创建 `suanming-data` 卷
|
||||
- **Docker 命令**: 需要手动挂载卷 `-v suanming-data:/app/data`
|
||||
|
||||
### 健康检查
|
||||
|
||||
容器内置健康检查:
|
||||
- **检查端点**: `/api/health`
|
||||
- **检查间隔**: 30秒
|
||||
- **超时时间**: 10秒
|
||||
- **重试次数**: 3次
|
||||
|
||||
## 📊 管理命令
|
||||
|
||||
### Docker Compose 命令
|
||||
|
||||
```bash
|
||||
# 启动服务
|
||||
docker-compose up -d
|
||||
|
||||
# 停止服务
|
||||
docker-compose down
|
||||
|
||||
# 重启服务
|
||||
docker-compose restart
|
||||
|
||||
# 查看日志
|
||||
docker-compose logs -f
|
||||
|
||||
# 查看服务状态
|
||||
docker-compose ps
|
||||
|
||||
# 进入容器
|
||||
docker-compose exec suanming-app sh
|
||||
|
||||
# 重新构建镜像
|
||||
docker-compose build --no-cache
|
||||
|
||||
# 更新并重启
|
||||
docker-compose pull && docker-compose up -d
|
||||
```
|
||||
|
||||
### Docker 命令
|
||||
|
||||
```bash
|
||||
# 查看容器状态
|
||||
docker ps
|
||||
|
||||
# 查看日志
|
||||
docker logs -f suanming-app
|
||||
|
||||
# 进入容器
|
||||
docker exec -it suanming-app sh
|
||||
|
||||
# 停止容器
|
||||
docker stop suanming-app
|
||||
|
||||
# 删除容器
|
||||
docker rm suanming-app
|
||||
|
||||
# 查看镜像
|
||||
docker images
|
||||
```
|
||||
|
||||
## 🔍 故障排除
|
||||
|
||||
### 常见问题
|
||||
|
||||
#### 1. 容器启动失败
|
||||
```bash
|
||||
# 查看详细日志
|
||||
docker-compose logs suanming-app
|
||||
|
||||
# 检查容器状态
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
#### 2. 端口被占用
|
||||
```bash
|
||||
# 检查端口占用
|
||||
netstat -tulpn | grep 8000
|
||||
|
||||
# 修改端口映射
|
||||
# 在 docker-compose.yml 中修改 ports: "8001:8000"
|
||||
```
|
||||
|
||||
#### 3. 数据库初始化失败
|
||||
```bash
|
||||
# 进入容器检查
|
||||
docker-compose exec suanming-app sh
|
||||
|
||||
# 手动初始化数据库
|
||||
node server/scripts/initDatabase.cjs
|
||||
```
|
||||
|
||||
#### 4. 构建失败
|
||||
```bash
|
||||
# 清理构建缓存
|
||||
docker system prune -a
|
||||
|
||||
# 重新构建
|
||||
docker-compose build --no-cache
|
||||
```
|
||||
|
||||
### 日志分析
|
||||
|
||||
```bash
|
||||
# 查看实时日志
|
||||
docker-compose logs -f --tail=100
|
||||
|
||||
# 查看特定时间段日志
|
||||
docker-compose logs --since="2024-01-01T00:00:00" --until="2024-01-01T12:00:00"
|
||||
|
||||
# 导出日志到文件
|
||||
docker-compose logs > app.log 2>&1
|
||||
```
|
||||
|
||||
## 🚀 生产环境部署
|
||||
|
||||
### 1. 安全配置
|
||||
|
||||
```bash
|
||||
# 生成强密码
|
||||
openssl rand -base64 32
|
||||
|
||||
# 设置环境变量
|
||||
export JWT_SECRET="your-generated-secret"
|
||||
```
|
||||
|
||||
### 2. 反向代理(Nginx)
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name your-domain.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:8000;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. HTTPS 配置
|
||||
|
||||
```bash
|
||||
# 使用 Let's Encrypt
|
||||
sudo certbot --nginx -d your-domain.com
|
||||
```
|
||||
|
||||
### 4. 监控和备份
|
||||
|
||||
```bash
|
||||
# 数据库备份
|
||||
docker-compose exec suanming-app cp /app/data/numerology.db /app/data/backup-$(date +%Y%m%d).db
|
||||
|
||||
# 定期备份脚本
|
||||
#!/bin/bash
|
||||
BACKUP_DIR="/backup/suanming"
|
||||
mkdir -p $BACKUP_DIR
|
||||
docker-compose exec suanming-app cp /app/data/numerology.db $BACKUP_DIR/numerology-$(date +%Y%m%d-%H%M%S).db
|
||||
```
|
||||
|
||||
## 📈 性能优化
|
||||
|
||||
### 1. 资源限制
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml
|
||||
services:
|
||||
suanming-app:
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: '1.0'
|
||||
memory: 512M
|
||||
reservations:
|
||||
cpus: '0.5'
|
||||
memory: 256M
|
||||
```
|
||||
|
||||
### 2. 多阶段构建优化
|
||||
|
||||
```dockerfile
|
||||
# 优化后的 Dockerfile
|
||||
FROM node:18-alpine AS builder
|
||||
WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm ci
|
||||
COPY . .
|
||||
RUN npm run build
|
||||
|
||||
FROM node:18-alpine AS production
|
||||
WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm ci --only=production && npm cache clean --force
|
||||
COPY --from=builder /app/dist ./dist
|
||||
COPY --from=builder /app/server ./server
|
||||
COPY --from=builder /app/public ./public
|
||||
RUN mkdir -p /app/data
|
||||
EXPOSE 8000
|
||||
CMD ["node", "server/index.cjs"]
|
||||
```
|
||||
|
||||
## 🔄 CI/CD 集成
|
||||
|
||||
### GitHub Actions 示例
|
||||
|
||||
```yaml
|
||||
name: Docker Build and Deploy
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Build Docker image
|
||||
run: docker build -t suanming-app .
|
||||
|
||||
- name: Run tests
|
||||
run: docker run --rm suanming-app npm test
|
||||
|
||||
- name: Deploy to production
|
||||
run: |
|
||||
docker save suanming-app | gzip > suanming-app.tar.gz
|
||||
# 部署到生产服务器
|
||||
```
|
||||
|
||||
## 📚 相关资源
|
||||
|
||||
- [Docker 官方文档](https://docs.docker.com/)
|
||||
- [Docker Compose 文档](https://docs.docker.com/compose/)
|
||||
- [Node.js Docker 最佳实践](https://nodejs.org/en/docs/guides/nodejs-docker-webapp/)
|
||||
- [项目 GitHub 仓库](https://github.com/your-username/suanming)
|
||||
|
||||
## 🆘 获取帮助
|
||||
|
||||
如果遇到问题:
|
||||
1. 查看本文档的故障排除部分
|
||||
2. 检查 Docker 和应用日志
|
||||
3. 在项目 GitHub 仓库创建 Issue
|
||||
4. 联系开发团队
|
||||
|
||||
---
|
||||
|
||||
**部署成功后,您的神机阁应用就可以通过 Docker 容器稳定运行了!** 🎉
|
||||
13
Dockerfile
13
Dockerfile
@@ -1,26 +1,23 @@
|
||||
# 使用官方Node.js运行时作为基础镜像
|
||||
FROM node:18-alpine
|
||||
|
||||
# 安装pnpm
|
||||
RUN npm install -g pnpm@9.0.0
|
||||
|
||||
# 设置工作目录
|
||||
WORKDIR /app
|
||||
|
||||
# 复制package.json和pnpm-lock.yaml
|
||||
COPY package.json pnpm-lock.yaml ./
|
||||
# 复制package.json和package-lock.json
|
||||
COPY package.json package-lock.json ./
|
||||
|
||||
# 安装所有依赖(包括开发依赖用于构建前端)
|
||||
RUN pnpm install --frozen-lockfile
|
||||
RUN npm ci
|
||||
|
||||
# 复制应用代码
|
||||
COPY . .
|
||||
|
||||
# 构建前端
|
||||
RUN pnpm run build
|
||||
RUN npm run build
|
||||
|
||||
# 清理开发依赖,只保留生产依赖
|
||||
RUN pnpm install --frozen-lockfile --prod
|
||||
RUN npm ci --only=production
|
||||
|
||||
# 创建数据目录用于SQLite数据库
|
||||
RUN mkdir -p /app/data
|
||||
|
||||
31
docker-compose.yml
Normal file
31
docker-compose.yml
Normal file
@@ -0,0 +1,31 @@
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
suanming-app:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
ports:
|
||||
- "8000:8000"
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
- PORT=8000
|
||||
- JWT_SECRET=${JWT_SECRET:-your-super-secret-jwt-key-change-this-in-production}
|
||||
volumes:
|
||||
# 持久化数据库文件
|
||||
- suanming-data:/app/data
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:8000/api/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 40s
|
||||
|
||||
volumes:
|
||||
suanming-data:
|
||||
driver: local
|
||||
|
||||
networks:
|
||||
default:
|
||||
name: suanming-network
|
||||
Reference in New Issue
Block a user