feat: 更新文档,添加GitHub镜像部署指南并优化Docker配置说明

This commit is contained in:
wood911010 committed 2025-10-12 12:33:19 +08:00
1 parent f0dee4a778
commit 7ad1ae310a
6 files changed
+86 -107

No files matched your search

+9 -1
View File
@@ -87,9 +87,17 @@ go build -o license-manager
./license-manager
```
##
## Docker 部署
### 使用预构建镜像(推荐)
如需快速部署且无需修改源码,可直接使用预构建的 GitHub Container Registry 镜像:
详细部署步骤请参考:[GitHub 镜像部署指南](docs/github-images-deploy.md)
### 从源码构建
推荐使用 Docker Compose,已提供开发与生产编排文件:
```bash
+8
View File
@@ -101,6 +101,14 @@ go build -o license-manager
## Docker Deployment
### Using Pre-built Images (Recommended)
For quick deployment without downloading source code, you can use pre-built GitHub Container Registry images:
For detailed deployment steps, please refer to: [GitHub Images Deployment Guide](docs/github-images-deploy.md)
### Build from Source
We provide ready-to-use Docker Compose files for development and production:
```bash
+2 -2
View File
@@ -13,7 +13,7 @@ services:
MYSQL_PASSWORD: license@123
TZ: Asia/Shanghai
ports:
- "3306:3306"
- "13306:3306"
volumes:
- mysql_data:/var/lib/mysql
healthcheck:
@@ -75,7 +75,7 @@ services:
environment:
- TZ=Asia/Shanghai
ports:
- "80:80"
- "18080:80"
volumes:
- ./nginx.conf:/etc/nginx/conf.d/default.conf:ro
depends_on:
File renamed without changes.
+67
View File
@@ -0,0 +1,67 @@
# GitHub 镜像快速部署指南
使用预构建的 GitHub Container Registry 镜像快速部署许可证管理系统。
## 快速部署
### 1. 获取部署文件
复制项目根目录的 `docker-compose.github.image.yml` 文件到你的部署目录:
```bash
# 方式一:直接下载
curl -O https://raw.githubusercontent.com/cedar-v/license-manager/main/docker-compose.github.image.yml
# 方式二:从项目中复制
cp docker-compose.github.image.yml /your/deploy/path/
```
### 2. 提取配置文件
```bash
# 提取后端配置文件
mkdir -p backend-config
docker run --rm -v $(pwd)/backend-config:/tmp/config ghcr.io/cedar-v/license-manager-backend:v0.1.0 sh -c "cp -r /app/backend/configs/* /tmp/config/"
# 提取前端 nginx 配置文件
docker run --rm -v $(pwd):/tmp/extract ghcr.io/cedar-v/license-manager-frontend:v0.1.0 sh -c "cp /etc/nginx/conf.d/default.conf /tmp/extract/nginx.conf"
```
### 3. 启动服务
```bash
docker-compose -f docker-compose.github.image.yml up
```
## 访问信息
- **前端**: http://localhost:18080
- **后端 API**: http://localhost:18888
- **默认账号**: admin / admin@123
## 常用命令
```bash
# 查看服务状态
docker-compose -f docker-compose.github.image.yml ps
# 查看日志
docker-compose -f docker-compose.github.image.yml logs -f
# 停止服务
docker-compose -f docker-compose.github.image.yml down
# 重启服务
docker-compose -f docker-compose.github.image.yml restart
# 完全清理(包括数据)
docker-compose -f docker-compose.github.image.yml down -v
```
## 配置修改
如需修改后端配置,编辑 `backend-config/config.prod.yaml` 文件,然后重启后端服务:
```bash
docker-compose -f docker-compose.github.image.yml restart backend
```
-104
View File
@@ -1,104 +0,0 @@
# GitHub镜像部署指南
使用预构建的GitHub Container Registry镜像快速部署许可证管理系统。
## 镜像信息
- **后端镜像**: `ghcr.io/cedar-v/license-manager-backend:v0.1.0`
- **前端镜像**: `ghcr.io/cedar-v/license-manager-frontend:v0.1.0`
## 快速部署
### 1. 初始化配置文件
```bash
# 创建配置目录
mkdir -p backend-config
# 从后端镜像中提取配置文件
docker run --rm -v $(pwd)/backend-config:/tmp/config ghcr.io/cedar-v/license-manager-backend:v0.1.0 sh -c "cp -r /app/backend/configs/* /tmp/config/"
# 从前端镜像中提取nginx配置文件
docker run --rm -v $(pwd):/tmp/extract ghcr.io/cedar-v/license-manager-frontend:v0.1.0 sh -c "cp /etc/nginx/conf.d/default.conf /tmp/extract/nginx.conf"
```
### 2. 启动服务
```bash
docker-compose -f docker-compose.github.image.yml up
```
### 3. 检查服务状态
```bash
docker-compose -f docker-compose.github.image.yml ps
```
## 访问地址
- **前端**: http://localhost
- **后端API**: http://localhost:18888
- **MySQL**: localhost:3306
## 默认账号
- **用户名**: admin
- **密码**: admin@123
## 停止服务
```bash
docker-compose -f docker-compose.github.image.yml down
```
## 清理数据
```bash
docker-compose -f docker-compose.github.image.yml down -v
```
## 故障排查
### 查看日志
```bash
# 查看所有服务日志
docker-compose -f docker-compose.github.image.yml logs
# 查看特定服务日志
docker-compose -f docker-compose.github.image.yml logs backend
docker-compose -f docker-compose.github.image.yml logs frontend
docker-compose -f docker-compose.github.image.yml logs mysql
```
### 重启服务
```bash
docker-compose -f docker-compose.github.image.yml restart
```
## 修改配置
### 提取配置文件
```bash
# 如果需要修改配置,先提取配置文件
mkdir -p backend-config
# 提取后端配置文件
docker run --rm -v $(pwd)/backend-config:/tmp/config ghcr.io/cedar-v/license-manager-backend:v0.1.0 sh -c "cp -r /app/backend/configs/* /tmp/config/"
# 提取前端nginx配置文件
docker run --rm -v $(pwd):/tmp/extract ghcr.io/cedar-v/license-manager-frontend:v0.1.0 sh -c "cp /etc/nginx/conf.d/default.conf /tmp/extract/nginx.conf"
```
### 修改配置
编辑 `backend-config/config.prod.yaml` 文件修改数据库连接、密钥等配置。
### 重启应用配置
```bash
# 重启后端服务使配置生效
docker-compose -f docker-compose.github.image.yml restart backend
```