95 lines
3.0 KiB
Markdown
95 lines
3.0 KiB
Markdown
# AIO 容器部署
|
|
|
|
本目录提供单容器部署：Nginx 在 `8080` 端口提供前端，并将
|
|
`/api/` 代理到同容器内的 Fastify；Fastify 复用固定版本
|
|
Playwright Chromium 生成 PDF。
|
|
|
|
## 启动
|
|
|
|
要求已经安装并启动 Docker Desktop。
|
|
|
|
```powershell
|
|
docker compose -f deploy\compose.yaml up --build -d
|
|
docker compose -f deploy\compose.yaml ps
|
|
```
|
|
|
|
打开：
|
|
|
|
```text
|
|
http://localhost:8080
|
|
```
|
|
|
|
健康检查：
|
|
|
|
```powershell
|
|
Invoke-RestMethod -Uri 'http://localhost:8080/api/health'
|
|
```
|
|
|
|
查看日志和停止：
|
|
|
|
```powershell
|
|
docker compose -f deploy\compose.yaml logs -f
|
|
docker compose -f deploy\compose.yaml down
|
|
```
|
|
|
|
## 构建发布标签
|
|
|
|
可以直接指定版本化镜像名称构建：
|
|
|
|
```powershell
|
|
$env:MD_TO_PDF_IMAGE = 'yixiong/md-to-pdf:v0.4.1'
|
|
docker compose -f deploy\compose.yaml build
|
|
```
|
|
|
|
该命令只生成本地镜像，不会自动推送到镜像仓库。
|
|
|
|
默认构建会安装项目锁定版本的 Playwright Chromium 及系统依赖。如果本机
|
|
已经保留同版本系列的已验证镜像，可在内网或软件源较慢时复用其运行层：
|
|
|
|
```powershell
|
|
$env:MD_TO_PDF_IMAGE = 'yixiong/md-to-pdf:v0.4.1'
|
|
$env:MD_TO_PDF_RUNTIME_BASE_IMAGE = 'yixiong/md-to-pdf:v0.3.1'
|
|
$env:MD_TO_PDF_REUSE_PLAYWRIGHT_RUNTIME = '1'
|
|
docker compose -f deploy\compose.yaml build
|
|
```
|
|
|
|
复用模式会校验基础镜像中存在 Chromium，再覆盖 v0.4.1 应用代码和生产
|
|
依赖。正式跨机器构建仍建议使用默认完整路径。
|
|
|
|
## 主题挂载
|
|
|
|
Compose 默认将项目的 `.local/themes` 只读挂载到容器中的
|
|
`/app/.local/themes`。可以通过环境变量指定其他目录：
|
|
|
|
```powershell
|
|
$env:MD_TO_PDF_THEME_DIR = 'D:\md-to-pdf-themes'
|
|
docker compose -f deploy\compose.yaml up -d
|
|
```
|
|
|
|
目录下每套主题都应包含 `theme.json`。主题规范详见
|
|
[`docs/THEMES.md`](../docs/THEMES.md)。
|
|
|
|
从 v0.4.0 起，公司内部私有版本已内置 GitHub、Pixyll 和 Whitey 三套
|
|
Typora 默认主题；挂载目录仍可用于本机扩展主题。内置主题与挂载主题 ID
|
|
重复时以内置版本为准。
|
|
|
|
## 运行参数
|
|
|
|
| 环境变量 | 默认值 | 说明 |
|
|
| --- | ---: | --- |
|
|
| `MD_TO_PDF_IMAGE` | `md-to-pdf:local` | 构建和运行的镜像标签 |
|
|
| `MD_TO_PDF_RUNTIME_BASE_IMAGE` | `node:22-bookworm-slim` | 可选运行时基础镜像 |
|
|
| `MD_TO_PDF_REUSE_PLAYWRIGHT_RUNTIME` | `0` | 是否复用基础镜像中的 Chromium |
|
|
| `MD_TO_PDF_PORT` | `8080` | 宿主机监听端口 |
|
|
| `MD_TO_PDF_THEME_DIR` | `../.local/themes` | 宿主机主题目录 |
|
|
| `PDF_CONCURRENCY` | `1` | 同时执行的 PDF 任务数 |
|
|
| `PDF_MAX_QUEUE` | `4` | 等待队列上限 |
|
|
| `PDF_TIMEOUT_MS` | `120000` | 单次 PDF 生成超时 |
|
|
|
|
增加 PDF 并发会显著增加 Chromium 内存占用。单机部署建议先保持默认值，
|
|
再根据文档复杂度和可用内存调整。
|
|
|
|
容器为 Chromium 提供 1 GiB 共享内存，并以非 root `pwuser` 运行。
|
|
构建阶段使用项目锁定的 Playwright `1.62.0` 安装精确匹配的 Chromium
|
|
及系统依赖，不依赖版本可能滞后的预制浏览器镜像标签。
|