diff --git a/docs/DOCKER_PULL.md b/docs/DOCKER_PULL.md deleted file mode 100644 index aeff6b5..0000000 --- a/docs/DOCKER_PULL.md +++ /dev/null @@ -1,42 +0,0 @@ -# Docker Pull & Run Guide (Local Deployment) - -This guide helps others run the system locally using prebuilt images. - -## Prerequisites -- Docker Desktop (Windows) or Docker Engine + Compose -- Network access to the registry - -## 1) Login to registry (private) -```bash -docker login docker.aizhangz.top -``` - -## 2) Create environment file -In the project root, create a `.env` file (example): -``` -APP_BASE_URL=http://localhost:5173 -TOKEN_SIGNING_KEY=please-change-me -JWT_SECRET=please-change-me -VOLCANO_API_KEY= -SPRING_MAIL_USERNAME= -SPRING_MAIL_PASSWORD= -``` - -## 3) Start with private registry images -```bash -docker compose -f docker-compose.private.yml up -d --pull always -``` - -## 4) Access -- Frontend: http://localhost:5173 -- Backend: http://localhost:8080 - -## Optional: Stop and remove -```bash -docker compose -f docker-compose.private.yml down -``` - -## Notes -- If login fails, verify registry URL and credentials. -- If API requests fail with 401/403 after a previous login, clear browser localStorage token: - - Open DevTools → Application → Local Storage → remove `token`. diff --git a/docs/DOCKER_COMPOSE_USAGE.md b/docs/Docker_Compose_使用说明.md similarity index 100% rename from docs/DOCKER_COMPOSE_USAGE.md rename to docs/Docker_Compose_使用说明.md diff --git a/docs/Docker_拉取与运行指南.md b/docs/Docker_拉取与运行指南.md new file mode 100644 index 0000000..ae6efc7 --- /dev/null +++ b/docs/Docker_拉取与运行指南.md @@ -0,0 +1,42 @@ +# Docker 拉取与运行指南（本地部署） + +本指南帮助他人使用预构建镜像在本地运行系统。 + +## 先决条件 +- Docker Desktop（Windows）或 Docker Engine + Compose +- 能访问镜像仓库的网络 + +## 1) 登录私有仓库 +```bash +docker login docker.aizhangz.top +``` + +## 2) 创建环境文件 +在项目根目录创建 `.env` 文件（示例）： +``` +APP_BASE_URL=http://localhost:5173 +TOKEN_SIGNING_KEY=please-change-me +JWT_SECRET=please-change-me +VOLCANO_API_KEY= +SPRING_MAIL_USERNAME= +SPRING_MAIL_PASSWORD= +``` + +## 3) 使用私有仓库镜像启动 +```bash +docker compose -f docker-compose.private.yml up -d --pull always +``` + +## 4) 访问 +- 前端：http://localhost:5173 +- 后端：http://localhost:8080 + +## 可选：停止并移除 +```bash +docker compose -f docker-compose.private.yml down +``` + +## 注意事项 +- 登录失败时，请检查仓库地址与账号凭据。 +- 若之前登录后 API 请求出现 401/403，请清理浏览器 localStorage 中的 token： + - 打开 DevTools → Application → Local Storage → 删除 `token`。 diff --git a/docs/DOCKER_PUBLISH.md b/docs/Docker_构建与发布指南.md similarity index 58% rename from docs/DOCKER_PUBLISH.md rename to docs/Docker_构建与发布指南.md index 852ac13..77ab0be 100644 --- a/docs/DOCKER_PUBLISH.md +++ b/docs/Docker_构建与发布指南.md @@ -1,69 +1,69 @@ -# Docker Build & Publish Guide +# Docker 构建与发布指南 -This guide explains how to package the project into Docker images and push them to a registry. +本指南说明如何将项目打包成 Docker 镜像并推送到镜像仓库。 -## Prerequisites +## 先决条件 - Docker Desktop / Docker Engine -- Network access to the registry -- Registry login credentials +- 能访问镜像仓库的网络 +- 镜像仓库登录凭据 -## Files you need -These files are required to build and publish: +## 需要的文件 +构建与发布需要以下文件： - `ems-backend/Dockerfile` - `ems-frontend/Dockerfile` - `ems-frontend/nginx.conf` -- `docker-compose.yml` (optional for local test) -- `.env` (do **not** publish; keep secrets local) +- `docker-compose.yml`（本地测试可选） +- `.env`（**不要**发布，保留在本地） -## 1) Build images locally -From the project root: +## 1) 本地构建镜像 +在项目根目录执行： ```bash docker build -t //ems-backend:latest ./ems-backend docker build -t //ems-frontend:latest --build-arg VITE_API_BASE_URL=/api ./ems-frontend ``` -Examples: -- Docker Hub: +示例： +- Docker Hub： ```bash docker build -t /ems-backend:latest ./ems-backend docker build -t /ems-frontend:latest --build-arg VITE_API_BASE_URL=/api ./ems-frontend ``` -- Private registry: +- 私有仓库： ```bash docker build -t docker.aizhangz.top/ems-backend:latest ./ems-backend docker build -t docker.aizhangz.top/ems-frontend:latest --build-arg VITE_API_BASE_URL=/api ./ems-frontend ``` -## 2) Login to registry +## 2) 登录镜像仓库 ```bash docker login ``` -Examples: +示例： ```bash docker login docker.aizhangz.top ``` -## 3) Push images +## 3) 推送镜像 ```bash docker push //ems-backend:latest docker push //ems-frontend:latest ``` -Examples (private registry): +示例（私有仓库）： ```bash docker push docker.aizhangz.top/ems-backend:latest docker push docker.aizhangz.top/ems-frontend:latest ``` -## 4) Verify -Pull once to confirm: +## 4) 验证 +拉取一次确认： ```bash docker pull //ems-backend:latest docker pull //ems-frontend:latest ``` -## Notes -- Never commit `.env` with secrets. -- If using a public registry, remove sensitive configs from images. -- For local run with images, use `docker-compose.hub.yml` or `docker-compose.private.yml`. +## 注意事项 +- 不要提交包含密钥的 `.env`。 +- 如果使用公共仓库，请移除镜像中的敏感配置。 +- 需要用镜像本地运行时，使用 `docker-compose.private.yml`。 diff --git a/docs/PROJECT_DOCS.md b/docs/项目文档汇总.md similarity index 97% rename from docs/PROJECT_DOCS.md rename to docs/项目文档汇总.md index 14b5547..5ad354a 100644 --- a/docs/PROJECT_DOCS.md +++ b/docs/项目文档汇总.md @@ -124,23 +124,23 @@ --- -### DOCKER_PULL.md - -# Docker Pull & Run Guide (Local Deployment) +### Docker_拉取与运行指南.md -This guide helps others run the system locally using prebuilt images. +# Docker 拉取与运行指南（本地部署） -## Prerequisites -- Docker Desktop (Windows) or Docker Engine + Compose -- Network access to the registry +本指南帮助他人使用预构建镜像在本地运行系统。 -## 1) Login to registry (private) +## 先决条件 +- Docker Desktop（Windows）或 Docker Engine + Compose +- 能访问镜像仓库的网络 + +## 1) 登录私有仓库 ```bash docker login docker.aizhangz.top ``` -## 2) Create environment file -In the project root, create a `.env` file (example): +## 2) 创建环境文件 +在项目根目录创建 `.env` 文件（示例）： ``` APP_BASE_URL=http://localhost:5173 TOKEN_SIGNING_KEY=please-change-me @@ -150,101 +150,101 @@ SPRING_MAIL_USERNAME= SPRING_MAIL_PASSWORD= ``` -## 3) Start with private registry images +## 3) 使用私有仓库镜像启动 ```bash docker compose -f docker-compose.private.yml up -d --pull always ``` -## 4) Access -- Frontend: http://localhost:5173 -- Backend: http://localhost:8080 +## 4) 访问 +- 前端：http://localhost:5173 +- 后端：http://localhost:8080 -## Optional: Stop and remove +## 可选：停止并移除 ```bash docker compose -f docker-compose.private.yml down ``` -## Notes -- If login fails, verify registry URL and credentials. -- If API requests fail with 401/403 after a previous login, clear browser localStorage token: - - Open DevTools → Application → Local Storage → remove `token`. +## 注意事项 +- 登录失败时，请检查仓库地址与账号凭据。 +- 若之前登录后 API 请求出现 401/403，请清理浏览器 localStorage 中的 token： + - 打开 DevTools → Application → Local Storage → 删除 `token`。 --- -### DOCKER_PUBLISH.md - -# Docker Build & Publish Guide +### Docker_构建与发布指南.md -This guide explains how to package the project into Docker images and push them to a registry. +# Docker 构建与发布指南 -## Prerequisites +本指南说明如何将项目打包成 Docker 镜像并推送到镜像仓库。 + +## 先决条件 - Docker Desktop / Docker Engine -- Network access to the registry -- Registry login credentials +- 能访问镜像仓库的网络 +- 镜像仓库登录凭据 -## Files you need -These files are required to build and publish: +## 需要的文件 +构建与发布需要以下文件： - `ems-backend/Dockerfile` - `ems-frontend/Dockerfile` - `ems-frontend/nginx.conf` -- `docker-compose.yml` (optional for local test) -- `.env` (do **not** publish; keep secrets local) +- `docker-compose.yml`（本地测试可选） +- `.env`（**不要**发布，保留在本地） -## 1) Build images locally -From the project root: +## 1) 本地构建镜像 +在项目根目录执行： ```bash docker build -t //ems-backend:latest ./ems-backend docker build -t //ems-frontend:latest --build-arg VITE_API_BASE_URL=/api ./ems-frontend ``` -Examples: -- Docker Hub: +示例： +- Docker Hub： ```bash docker build -t /ems-backend:latest ./ems-backend docker build -t /ems-frontend:latest --build-arg VITE_API_BASE_URL=/api ./ems-frontend ``` -- Private registry: +- 私有仓库： ```bash docker build -t docker.aizhangz.top/ems-backend:latest ./ems-backend docker build -t docker.aizhangz.top/ems-frontend:latest --build-arg VITE_API_BASE_URL=/api ./ems-frontend ``` -## 2) Login to registry +## 2) 登录镜像仓库 ```bash docker login ``` -Examples: +示例： ```bash docker login docker.aizhangz.top ``` -## 3) Push images +## 3) 推送镜像 ```bash docker push //ems-backend:latest docker push //ems-frontend:latest ``` -Examples (private registry): +示例（私有仓库）： ```bash docker push docker.aizhangz.top/ems-backend:latest docker push docker.aizhangz.top/ems-frontend:latest ``` -## 4) Verify -Pull once to confirm: +## 4) 验证 +拉取一次确认： ```bash docker pull //ems-backend:latest docker pull //ems-frontend:latest ``` -## Notes -- Never commit `.env` with secrets. -- If using a public registry, remove sensitive configs from images. -- For local run with images, use `docker-compose.hub.yml` or `docker-compose.private.yml`. +## 注意事项 +- 不要提交包含密钥的 `.env`。 +- 如果使用公共仓库，请移除镜像中的敏感配置。 +- 需要用镜像本地运行时，使用 `docker-compose.hub.yml` 或 `docker-compose.private.yml`。