如何运行和配置自己的 BreezeWiki

BreezeWiki 可以自行部署，文档给出的运行方式有三种：运行编译好的可执行文件、从源码运行、用 Docker 运行。选择哪一种取决于你手上有没有现成的二进制、是否愿意安装 Racket 工具链，以及是否习惯用容器管理服务。三种方式跑起来之后，配置都通过同一套选项完成——必需选项、详细选项，可以用配置文件，也可以用环境变量传入。

运行方式

运行编译好的可执行文件

适合不想碰源码和构建工具的情况。拿到对应平台的可执行文件后直接启动即可，不需要额外安装开发环境。文档把这一节和「从源码运行」并列，说明它是官方认可的常规路径之一。

从源码运行

需要先准备好源码运行所需的语言环境（文档在「Developing BreezeWiki」一节里专门讲了 Racket，说明源码运行依赖 Racket 工具链）。流程上分两步：先获取源码，再启动；后续如果上游有更新，文档单独给了「更新源码」的说明，按那一节操作即可。

用 Docker 运行

适合希望把依赖和运行环境一起打包、避免在宿主机上装工具链的场景。文档为 Docker 单独列了一节，说明它是被支持的部署方式，而不是需要自己拼凑的偏方。

资源占用

文档专门有一节讲资源使用情况（Resource usage），部署前值得先看这一节，用来判断你的机器或容器配额是否够用。具体数值以文档该节为准。

配置

配置分两层：必需选项（Required options）和详细选项（Detailed Options）。必需选项不填就跑不起来，详细选项按需调整。

传入配置有两种途径：

  • 配置文件：文档给出了示例（Example）和格式说明（Format），照着格式写即可。
  • 环境变量：同样给了示例（Example），适合容器化部署时注入配置。

两种方式覆盖的是同一组选项，选一种顺手的即可，不必混用。

跑起来之后

  • 自动重定向：如果你部署实例的目的是让访问 Fandom 的人自动转到自己的 BreezeWiki，文档在「Automatic Redirection」一节给了多种做法，包括浏览器扩展 Indie Wiki Buddy、Redirector、Violentmonkey、LibRedirect，以及 Apple iPhone 上的重定向方式。
  • 报告 bug：自己跑的过程中遇到问题，文档有「Reporting Bugs」一节，其中「Actually sending a report」说明了实际提交报告的渠道，另有其他沟通渠道。
  • 继续开发：文档末尾的「Developing BreezeWiki」覆盖 Racket、文件结构、Fandom 端点、HTML 树变换、编程和测试，适合想在自建实例上做改动的人。

官方站点与镜像

文档的「Links」一节列出了官方站点、镜像（Mirrors）和 Onion 镜像三类地址。官方站点是 https://breezewiki.com。部署前可以先访问官方实例，确认它是否符合你的预期，再决定自建。

docs.breezewiki.com