add docs
This commit is contained in:
@@ -163,6 +163,7 @@ docker compose up -d --build # 重新构建并启动
|
||||
|
||||
| 变量 | 默认值 | 说明 |
|
||||
|------|--------|------|
|
||||
| `OPENOCR_ROOT_PATH` | *(空)* | 反向代理子路径,如 `/openocr` |
|
||||
| `OPENOCR_OUTPUT_DIR` | `data/output` | 解析结果输出目录 |
|
||||
| `OPENOCR_UPLOAD_DIR` | `data/uploads` | 上传文件临时目录 |
|
||||
| `OPENOCR_USE_GPU` | `false` | 是否使用 GPU |
|
||||
@@ -191,6 +192,35 @@ docker compose up -d --build # 重新构建并启动
|
||||
└── .env.example
|
||||
```
|
||||
|
||||
## 反向代理(Nginx 子路径)
|
||||
|
||||
若通过 `https://jsuse.com/openocr/` 这类**子路径**访问(而非直接 `:8000`),必须在 `.env` 中设置:
|
||||
|
||||
```env
|
||||
OPENOCR_ROOT_PATH=/openocr
|
||||
```
|
||||
|
||||
否则 `/health` 可能正常,但 `/docs` 会报 **Failed to load API definition**——因为 Swagger 会去根路径请求 `/openapi.json`,而不是 `/openocr/openapi.json`。
|
||||
|
||||
Nginx 参考配置:
|
||||
|
||||
```nginx
|
||||
location /openocr/ {
|
||||
proxy_pass http://127.0.0.1:8000/;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
```
|
||||
|
||||
修改后重启容器:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
- `.env`、`data/`、模型缓存目录已在 `.gitignore` 中排除,不会进入 Git
|
||||
|
||||
Reference in New Issue
Block a user