一站式自托管阅读平台BookOrbit

# 运行的 Docker 镜像。为更严格的部署请固定为 sha-* 标签或 @sha256 摘要。
APP_IMAGE=ghcr.io/bookorbit/bookorbit:latest

# 主机上应用公开的端口
APP_PORT=3622

# 主机上在容器内映射为 /books 的文件夹。
# 将其指向你的图书馆根目录；在 NAS 或 Portainer 安装中请使用绝对路径。
BOOKS_HOST_PATH=./books

# 可选：Book Dock 投放区在主机上的文件夹（在容器内映射为 /data/book-dock）。
# 将电子书复制或移动到此处，Book Dock 会自动拾取并处理它们。
# 如果未设置，投放文件夹位于 ./data/app/book-dock（默认应用数据卷）内。
# 在挂载 NAS 共享或使用应用数据目录之外管理的文件夹时请使用绝对路径。
# BOOK_DROP_HOST_PATH=/mnt/nas/book-drop

# 容器运行时写入应用管理的数据文件夹时使用的 UID/GID。
# 大多数用户可保留这些默认值。
PUID=1000
PGID=1000

# 数据库凭据
POSTGRES_USER=bookorbit
POSTGRES_PASSWORD=change-this-password
POSTGRES_DB=bookorbit

# 应用密钥
JWT_SECRET=change-this-to-a-long-random-secret

# 用于初次调用 /auth/setup 端点（x-setup-token 请求头）的必需项
SETUP_BOOTSTRAP_TOKEN=change-this-to-a-long-random-secret

# 用于电子邮件和 Kobo 端点的外部/公共 URL
APP_URL=https://bookorbit.example.com

# Node.js JavaScript 堆内存上限，单位为 MB。对于非常大的图书库请提高该值。
NODE_MAX_OLD_SPACE_SIZE=2048

# --- 可选覆盖项（取消注释以设置） ---

# 如果你已经运行自己的 PostgreSQL，请设置 DATABASE_URL 并从 docker-compose.yml 中移除 postgres 服务。你的实例必须启用
# uuid-ossp、pg_trgm 和 vector (pgvector) 扩展。
# DATABASE_URL=postgres://user:password@yourhost:5432/bookorbit
# 或者分别设置各个字段（POSTGRES_HOST、POSTGRES_PORT、POSTGRES_USER、POSTGRES_PASSWORD、POSTGRES_DB）

# 客户端前端在与 APP_URL 不同域名下提供服务时的 CORS 来源
# CLIENT_URL=https://app.example.com

# 仅在你的平台外部管理绑定挂载所有权时将其设置为 false。
# BOOKORBIT_FIX_PERMISSIONS=true

# 如果你存储 SMTP 提供商凭据，建议设置（生成方法：openssl rand -hex 32）
# EMAIL_ENCRYPTION_KEY=

# 如果你存储迁移源凭据，建议设置（生成方法：openssl rand -hex 32）
# MIGRATION_ENCRYPTION_KEY=

# 日志级别（默认：info）。设置为 debug 可输出详细日志。
# LOG_LEVEL=info

# 允许解析到私有/本地域名的 OIDC issuer/discovery URL。
# 默认 false。仅在受信任的自托管网络中启用。
# OIDC_ALLOW_LOCAL_ISSUERS=false

# 可选：在使用自动设置时允许 Cloudflare Web Analytics 信标。
# 保持不设置或 false 可保留严格的内容安全策略（CSP）（`script-src 'self'`）。
# CSP_ALLOW_CLOUDFLARE_INSIGHTS=false

# 应用设置
APP_IMAGE=ghcr.io/bookorbit/bookorbit:latest
APP_PORT=3622

BOOKS_HOST_PATH=./books

# UID/GID
PUID=1000
PGID=1000

# 数据库凭据
POSTGRES_USER=bookorbit
POSTGRES_PASSWORD=bookorbit123
POSTGRES_DB=bookorbit

# 应用密钥可以用 openssl rand -hex 32 生成
JWT_SECRET=bf7dd22b68918a7a0044d0ec115c1f930e53de49d97a091c017fcd9318751100

# 用于初次调用 /auth/setup 端点（x-setup-token 请求头）的必需项
SETUP_BOOTSTRAP_TOKEN=adde1f95b500d897e64bbf12198a4b2f9b426bac9162eb5c7edbeaff9d648f57

# 用于电子邮件和 Kobo 端点的外部/公共 URL
APP_URL=http://192.168.0.197:3622

# Node.js JavaScript 堆内存上限，单位为 MB。对于非常大的图书库请提高该值。
NODE_MAX_OLD_SPACE_SIZE=2048

version: '3.8'

services:
app:
    image:${APP_IMAGE}
    container_name:bookorbit-app
    restart:unless-stopped
    init:true
    env_file:
      -env.txt
    ports:
      -"${APP_PORT}:${PORT:-3000}"
    environment:
      NODE_ENV:production
    depends_on:
      postgres:
        condition:service_healthy
    volumes:
      -./books:/books                             # 电子书存放目录
      -./data/app:/data                           # 应用数据目录
      -./data/app/book-dock:/data/book-dock       # 自动摄入目录
    read_only:true
    tmpfs:
      -/tmp
    cap_drop:
      -ALL
    cap_add:
      -CHOWN
      -DAC_OVERRIDE
      -FOWNER
      -SETGID
      -SETUID
    security_opt:
      -no-new-privileges:true
    stop_grace_period:30s
    healthcheck:
      test:
        [
          "CMD-SHELL",
          'node -e "fetch(''http://127.0.0.1:''+(process.env.PORT||3000)+''/api/v1/health'').then(r=>process.exit(r.ok?0:1)).catch(()=>process.exit(1))"',
        ]
      interval:30s
      timeout:5s
      retries:3
      start_period:20s
      
postgres:
    image:pgvector/pgvector:pg16
    container_name:bookorbit-db
    restart:unless-stopped
    environment:
      POSTGRES_USER:${POSTGRES_USER}
      POSTGRES_PASSWORD:${POSTGRES_PASSWORD}
      POSTGRES_DB:${POSTGRES_DB}
      PGDATA:/var/lib/postgresql/data/pgdata
    volumes:
      -./data/postgres:/var/lib/postgresql/data   # 数据库持久化
    healthcheck:
      test:["CMD-SHELL",'pg_isready -U "${POSTGRES_USER}" -d "${POSTGRES_DB}"']
      interval:10s
      timeout:5s
      retries:10
      start_period:20s

# 新建文件夹 bookorbit 和 子目录
mkdir -p /volume1/docker/bookorbit/{books,data/{app/book-dock,postgres}}

# 进入 bookorbit 目录
cd /volume1/docker/bookorbit

# 将 docker-compose.yml 放入当前目录

# 一键启动
docker-compose --env-file env.txt up -d