Man page - calibre-server(1)

Packages contains this manual

Available languages:

en fr mr pt_BR is es kn it ca pl vi nb sl lv pt eo ms ko fa eu et nl ar da cs gl tr zh_HK sk hu bg sv hr ja he lt uk fi ru ro zh_TW sr ka el zh_CN de

Manual

CALIBRE-SERVER

NAME
[选 项 ]
AUTHOR
COPYRIGHT

NAME

calibre-server - calibre-server

calibre-server [选 项 ] [书 库 文 件 夹 的 路 径 ...]

启 动 caliber内 容 服 务 器 。 calibre 内 容 服 务 器 通 过 互 联 网 公 开 你 的 calibre 书 库 。 你 可 以 将 书 库 文 件 夹 的 路 径 指 定 为 :command: calibre-server 参 数 。 如 果 未 指 定 任 何 路 径 ， 将 使 用 calibre程 序 所 知 道 的 所 有 书 库 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"

[选 项 ]

--access-log

访 问 日 志 文 件 的 路 径 。 此 日 志 包 含 有 关 连 接 到 服 务 器 并 发 出 请 求 的 客 户 端 的 信 息 。 默 认 情 况 下 ， 不 记 录 访 问 日 志 。

--ajax-timeout

在 查 询 时 等 待 服 务 器 响 应 的 时 间 (秒 ).

--auth-mode

选 择 认 证 方 式 . 设 置 服 务 器 使 用 的 HTTP身 份 验 证 模 式 。 如 果 将 服 务 器 放 在 SSL代 理 后 面 ， 则 设 置 为 " basic " ， 否 则 将 其 设 为 " auto " 。 如 果 配 置 了 SSL， 将 使 用 " basic " ， 否 则 使 用 " digest " 。

--auto-reload

当 源 代 码 更 改 时 自 动 重 新 加 载 服 务 器 。 有 利 于 开 发 。 应 该 为 关 闭 超 时 指 定 一 个 较 小 的 值 。

--ban-after

触 发 封 禁 的 登 录 失 败 次 数 . 达 到 该 登 录 失 败 次 数 后 IP地 址 将 被 封 禁

--ban-for

封 禁 反 复 登 录 失 败 的 IP地 址 . 临 时 禁 止 在 指 定 的 分 钟 数 内 反 复 登 录 失 败 的 IP地 址 的 访 问 。 有 助 于 防 止 猜 测 密 码 。 如 果 设 置 为 零 则 不 禁 止 。

--book-list-mode

选 择 默 认 的 书 籍 列 表 显 示 模 式 . 设 置 用 于 新 用 户 的 默 认 书 籍 列 表 模 式 . 每 名 用 户 都 可 以 单 独 重 新 设 置 此 选 项 .默 认 使 用 封 面 网 格 。

--compress-min-size

响 应 使 用 数 据 压 缩 的 最 小 大 小 (字 节 ).

--custom-list-template

包 含 自 定 义 书 籍 列 表 模 式 的 模 板 的 JSON文 件 的 路 径 。 创 建 这 种 模 板 文 件 的 最 简 单 方 法 是 在 caliber中 前 往 ' 首 选 项 ->通 过 网 络 共 享 ->书 籍 列 表 模 板 ' ， 创 建 模 板 并 导 出 它 。

--daemonize

进 程 在 后 台 运 行 为 守 护 进 程 （ 仅 Linux） 。

--displayed-fields

用 户 自 定 义 字 段 的 显 示 限 制 . 逗 号 分 隔 的 用 户 自 定 义 元 数 据 字 段 的 列 表 ， 将 由 内 容 服 务 器 在 /opds 和 /mobile 视 图 中 显 示 。 如 果 指 定 此 选 项 ， 仅 显 示 此 列 表 中 包 含 的 字 段 。 例 如 : my_rating,my_tags

--enable-allow-socket-preallocation,
--disable-allow-socket-preallocation

端 口 预 分 配 ， 例 如 ， 使 用 systemd的 端 口 激 活 . 默 认 情 况 下 , 此 选 项 是 启 用 的 。

--enable-auth, --disable-auth

访 问 服 务 器 时 要 求 基 于 密 码 的 身 份 验 证 . 通 常 ， 服 务 器 是 不 受 限 制 的 ， 允 许 任 何 人 访 问 它 。 你 可 以 使 用 此 选 项 限 制 对 预 定 义 用 户 的 访 问 。 默 认 情 况 下 , 此 选 项 是 禁 用 的 。

--enable-fallback-to-detected-interface,
--disable-fallback-to-detected-interface

替 换 为 自 动 检 测 到 的 接 口 . 如 果 由 于 某 种 原 因 ， 服 务 器 无 法 绑 定 到 listen_on选 项 中 指 定 的 端 口 ， 那 么 它 将 尝 试 检 测 连 接 到 外 界 的 端 口 并 绑 定 到 该 端 口 。 默 认 情 况 下 , 此 选 项 是 启 用 的 。

--enable-local-write, --disable-local-write

允 许 未 经 身 份 验 证 的 本 地 连 接 更 改 书 库 . 通 常 ， 如 果 你 不 打 开 身 份 验 证 ， 则 服 务 器 以 只 读 模 式 运 行 ， 从 而 不 允 许 匿 名 用 户 更 改 你 的 calibre 书 库 。 此 选 项 允 许 任 何 人 从 服 务 器 所 在 的 计 算 机 来 更 改 书 库 。 如 果 你 想 在 没 有 身 份 验 证 的 情 况 下 运 行 服 务 器 ， 但 是 仍 然 使 用 calibredb对 你 的 calibre 书 库 进 行 更 改 ， 那 么 这 选 项 是 非 常 有 用 。 请 注 意 ， 打 开 这 个 选 项 后 意 味 着 在 服 务 器 所 在 的 计 算 机 上 运 行 的 任 何 程 序 都 可 以 对 你 的 calibre 书 库 进 行 更 改 。 默 认 情 况 下 , 此 选 项 是 禁 用 的 。

--enable-log-not-found, --disable-log-not-found

记 录 HTTP 404(未 找 到 )的 请 求 . 通 常 ， 服 务 器 会 记 录 所 有 未 找 到 资 源 的 HTTP请 求 。 如 果 你 的 服 务 器 被 恶 意 程 序 攻 击 ， 则 会 产 生 大 量 的 垃 圾 日 志 。 使 用 此 选 项 可 将 其 关 闭 。 默 认 情 况 下 , 此 选 项 是 启 用 的 。

--enable-use-bonjour, --disable-use-bonjour

通 过 BonJour广 播 OPDS源 . 通 过 BonJour广 播 OPDS源 ， 这 样 基 于 OPDS的 阅 读 应 用 程 序 就 可 以 自 动 检 测 和 连 接 到 服 务 器 。 默 认 情 况 下 , 此 选 项 是 启 用 的 。

--enable-use-sendfile, --disable-use-sendfile

传 输 时 不 复 制 文 件 以 提 高 性 能 . 当 通 过 网 络 发 送 文 件 时 ， 将 在 内 核 传 输 中 使 用 零 复 制 ， 从 而 提 高 性 能 。 但 是 ， 它 可 能 会 导 致 在 某 些 损 坏 的 文 件 系 统 上 的 文 件 传 输 异 常 。 如 果 遇 到 文 件 传 输 异 常 ， 请 将 其 关 闭 。 默 认 情 况 下 , 此 选 项 是 启 用 的 。

--help, -h

显 示 此 帮 助 信 息 并 退 出

--ignored-fields

忽 略 用 户 自 定 义 的 元 数 据 字 段 . 逗 号 分 隔 用 户 自 定 义 的 元 数 据 字 段 的 列 表 ， 相 应 的 字 段 将 不 显 示 在 内 容 服 务 器 的 /opds 和 /mobile 的 视 图 中 。 例 如 : my_rating,my_tags

--listen-on

侦 听 连 接 的 端 口 . 默 认 情 况 下 ， 侦 听 所 有 可 用 的 IPv6和 IPv4接 口 。 例 如 ， 您 可 以 将 其 更 改 为 “127.0.0.1”以 仅 侦 听 来 自 本 地 计 算 机 的 IPv4连 接 ， 或 更 改 为 “0.0.0.0”以 侦 听 所 有 传 入 的 IPv4连 接 。

--log

服 务 器 日 志 的 文 件 路 径 。 此 日 志 包 含 服 务 器 信 息 和 错 误 ， 而 不 是 访 问 日 志 。 默 认 情 况 下 ， 它 被 写 入 标 准 输 出 (stdout)文 件 。

--manage-users

管 理 允 许 连 接 到 此 服 务 器 的 用 户 的 数 据 库 。 您 可 以 通 过 添 加 一 个 -- 以 在 自 动 模 式 下 使 用 它 。 有 关 详 情 ， 请 参 阅 calibre-server --manage-users -- help。 另 请 参 阅 --userdb 选 项 。

--max-header-line-size

单 个 HTTP 消 息 头 的 最 大 大 小 （ KB） .

--max-job-time

工 作 进 程 的 最 大 时 间 . 允 许 工 作 进 程 运 行 的 最 大 时 间 量 (分 钟 )。 设 为 零 则 无 限 制 。

--max-jobs

最 大 工 作 进 程 数 . 工 作 进 程 按 需 启 动 ， 用 于 大 型 任 务 ， 如 准 备 书 籍 以 供 阅 读 、 添 加 书 籍 、 转 换 等 。 通 常 ， 此 类 进 程 的 最 大 数 量 取 决 于 CPU内 核 的 数 量 。 您 可 以 通 过 此 设 置 控 制 它 。

--max-log-size

日 志 文 件 最 大 大 小 （ MB） . 由 服 务 器 生 成 的 日 志 文 件 的 最 大 容 量 。 当 日 志 变 得 大 于 这 个 容 量 时 ， 旧 日 志 将 被 自 动 覆 盖 。 设 置 为 零 时 禁 用 日 志 覆 盖 。

--max-opds-items

OPDS源 的 最 大 书 籍 数 . 服 务 器 将 在 单 个 OPDS请 求 中 返 回 的 最 大 书 籍 数 量 。

--max-opds-ungrouped-items

OPDS源 中 未 分 组 项 目 的 最 大 数 量 . 当 有 超 过 这 个 设 定 数 量 的 结 果 时 将 以 如 作 者 /标 签 的 首 字 母 对 返 回 的 结 果 进 行 分 组 。 设 置 为 零 以 禁 用 分 组 。

--max-request-body-size

服 务 器 允 许 上 传 的 最 大 文 件 大 小 （ MB） .

--num-per-page

在 一 页 中 显 示 的 书 籍 数 量 . 浏 览 器 中 单 个 页 面 显 示 的 书 籍 数 量 。

--pidfile

写 入 进 程 PID 到 指 定 的 文 件

--port

侦 听 连 接 的 端 口 .

--search-the-net-urls

包 含 “在 网 上 搜 索 ”指 定 的 URL的 JSON文 件 的 路 径 。 创 建 这 样 的 文 件 最 简 单 的 方 法 是 进 入 ' 首 选 项 ->通 过 网 络 共 享 ->在 网 上 搜 索 ' ， 创 建 URL并 将 其 导 出 。

--shutdown-timeout

等 待 完 全 关 闭 的 总 时 间 (秒 ).

--ssl-certfile

SSL证 书 文 件 的 路 径 .

--ssl-keyfile

SSL私 钥 文 件 的 路 径 .

--timeout

空 闲 连 接 关 闭 的 等 待 时 间 (秒 ).

--trusted-ips

允 许 来 自 特 定 IP的 未 经 身 份 验 证 的 连 接 更 改 书 库 . 通 常 ， 如 果 您 不 打 开 身 份 验 证 ， 服 务 器 将 以 只 读 模 式 运 行 ， 从 而 不 允 许 匿 名 用 户 更 改 您 的 Calibre书 库 。 此 选 项 允 许 从 指 定 IP连 接 的 任 何 人 修 改 书 库 。 必 须 是 逗 号 分 隔 的 网 络 地 址 或 网 络 规 范 的 列 表 。 如 果 您 希 望 在 不 进 行 身 份 验 证 的 情 况 下 运 行 服 务 器 ， 但 仍 使 用 Calibredb对 您 的 Calibre书 库 进 行 更 改 ， 则 此 功 能 非 常 有 用 。 请 注 意 ， 启 用 此 选 项 意 味 着 从 指 定 IP连 接 的 任 何 人 都 可 以 更 改 您 的 Calibre库 。

--url-prefix

所 有 URL的 预 置 前 缀 . 如 果 希 望 在 反 向 代 理 后 运 行 此 服 务 器 ， 则 非 常 有 用 。 例 如 ， 使 用 /calibre 作 为 URL前 缀 。

--userdb

用 于 身 份 验 证 的 用 户 数 据 库 路 径 。 数 据 库 是 SQLite文 件 。 使 用 :option:
`
--manage-users`创 建 它 。 您 可 以 阅 读 以 下 关 于 管 理 用 户 的 信 息 ： - https://manual.calibre-ebook.com/server.html#managing-user-accounts-from-the-command-line-only

--version

显 示 程 序 版 本 号 并 退 出

--worker-count

用 于 处 理 请 求 的 任 务 线 程 数 .

AUTHOR

Kovid Goyal

COPYRIGHT

Kovid Goyal