diff --git a/README.md b/README.md index 7af3a277cf6f2ca9e6bb14586e8b0334ea512db7..c85ebc41532f6ff26a611cd8dabcb71be1817aad 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,17 @@ ### 使用 Docker(推荐) ```bash -# 启动服务(包含后端 API 和前端 Web) -docker-compose up -d +# 构建并启动服务(首次运行或代码更新后) +docker-compose up -d --build # 查看日志 docker-compose logs -f # 停止服务 docker-compose down + +# 重启服务 +docker-compose restart ``` 服务启动后访问: @@ -34,6 +37,8 @@ docker-compose down - **API 服务**:http://localhost:8300 - **API 文档**:http://localhost:8300/docs 或 http://localhost:8300/redoc +**注意**:首次部署或更新代码后,请使用 `--build` 参数重新构建镜像。 + ### 本地开发 ```bash @@ -221,7 +226,23 @@ markitdown-api/ ## 常见问题 -### 1. 如何修改时区? +### 1. 首次部署需要做什么? + +首次部署需要构建 Docker 镜像: + +```bash +# 克隆或下载项目后 +docker-compose up -d --build +``` + +### 2. 代码更新后如何重新部署? + +```bash +# 拉取最新代码后 +docker-compose up -d --build +``` + +### 3. 如何修改时区? 编辑 `docker-compose.yml` 文件中的 `TZ` 环境变量: @@ -230,35 +251,49 @@ environment: - TZ=Asia/Shanghai # 修改为你需要的时区 ``` -### 2. 数据存储在哪里? +### 4. 数据存储在哪里? 所有数据存储在项目根目录的 `data` 目录下: - `data/file_registry.db` - SQLite 数据库 - `data/files/` - 转换的文件(按 UUID 组织) -### 3. 如何查看日志? +### 5. 如何查看日志? ```bash +# 查看所有服务日志 docker-compose logs -f + +# 只查看后端日志 +docker-compose logs -f markitdown-api + +# 只查看前端日志 +docker-compose logs -f markitdown-web ``` -### 4. 如何重启服务? +### 6. 如何重启服务? ```bash +# 重启所有服务 docker-compose restart + +# 只重启后端 +docker-compose restart markitdown-api + +# 只重启前端 +docker-compose restart markitdown-web ``` -### 5. 如何清理所有数据? +### 7. 如何清理所有数据? ```bash -# 停止服务 +# 停止并删除容器 docker-compose down # 删除数据目录(谨慎操作!) rm -rf data/ -# 重新启动 -docker-compose up -d +# 重新构建并启动 +docker-compose up -d --build ``` ## License diff --git a/web/README.md b/web/README.md index 0be616fa32688c94e68874d143c81c07221bbb52..bf5c7ab3d92f667166a25b14e035edf82628c953 100644 --- a/web/README.md +++ b/web/README.md @@ -34,17 +34,21 @@ npm run build ### Docker 部署 ```bash -# 在项目根目录使用 docker-compose +# 推荐:在项目根目录使用 docker-compose(包含前后端) cd .. -docker-compose up -d +docker-compose up -d --build -# 或单独构建前端镜像 +# 或单独构建前端镜像(需要手动配置后端连接) docker build -t markitdown-web:latest . docker run -d -p 8310:8310 --name markitdown-web markitdown-web:latest ``` 访问 http://localhost:8310 +**注意**: +- 使用 `--build` 参数确保构建最新代码 +- 单独部署前端时,需要确保 `nginx.conf` 中的 API 代理地址正确指向后端服务 + ## 主要功能 - **上传转换**:支持拖拽上传、实时转换、一键复制、快速跳转文件列表