跳转到主要内容
我们在这里整理了一些关于 Ayakaleaf Pro 的常见问题解答。

基本问题

不是。Ayakaleaf Pro 完全免费使用。它不是试用版,也不需要任何许可证。
是的。Ayakaleaf Pro 包含 Overleaf Server Pro 的所有功能,包括 Git-Bridge 集成。它还包含 Overleaf SaaS 平台的部分功能。我们会持续开发和改进 Ayakaleaf Pro。
Overleaf Server Pro 每位用户每年的费用约为 $300。它至少需要购买 10 个许可证,因此部署起步价约为每年 $3,000。美国一些较小规模的公开合同显示,每位用户每年的费用约为 $320–$370。这使得 Server Pro 价格昂贵,对于小型团队尤其如此。有关已记录的采购和价格信息,请参阅 #information-and-price-about-overleaf-server-pro。
Overleaf Server Pro 通常被政府机构使用。它们将其部署在私有网络中,并严格控制访问。为了保护敏感数据,其包含的功能会避免与第三方服务交换数据。如果你需要 GitHub 同步、AI 或类似的联网功能,Overleaf 建议订阅其 SaaS 平台。
Ayakaleaf Pro 是开源的。我们使用 Codex Security 等工具审查代码,以增强其安全性和可靠性。如果你不启用第三方数据同步,你的数据将始终保留在你的服务器上。Ayakaleaf Pro 不包含任何会将你的数据发送到其他地方的遥测功能。
我们将尽一切努力长期维护这个项目。
Ayakaleaf Pro 是一个社区分支。其代码和集成功能来自社区贡献,并采用 AGPL v3 许可证。只要满足该许可证的要求,部署即可符合其规定。
该项目最初于 2024 年命名为 Overleaf Pro。开发曾暂停一段时间,之后在 2025 年底重新启动。2026 年第一季度,Overleaf 将其支持 AI 的订阅计划更名为 Pro。社区反馈也指出,Overleaf Pro 这个名称可能带来商标和冒充风险,可能会让用户误以为该项目是官方项目。为避免这种混淆,我们将项目更名为 Ayakaleaf Pro。这个名称可以理解为”Ayaka-notes Overleaf Pro”。维护者(你可以叫我 ayaka!)从五年多前的学生时代起就一直为 Overleaf 社区开发做贡献。这段经历是我们长期维护承诺的有力支撑。
自 2026 年以来,开源社区发布了许多 AI 构建的 LaTeX 编辑器,包括 OpenAI Prism。Ayakaleaf Pro 将你的数据和服务保留在你自己的服务器上,让你能够直接掌控自己的部署和数据。许多实验性的社区编辑器并没有成熟的长期维护计划。第三方 LaTeX 编译平台也可能在用户群或收入不足时停止运营。Ayakaleaf Pro 提供全部源代码,并允许你自行托管每一项服务。即使维护停止,你现有的自托管服务也可以继续运行。
随着项目更名(参见 Q08),它已更名为 ayaka-notes/ayakaleaf-pro。它没有被归档或替换:这仍是同一个仓库,GitHub 会将旧的 ayaka-notes/overleaf-pro 链接和 Git 远程地址重定向到新名称。Docker 镜像保留原名 ghcr.io/ayaka-notes/overleaf-pro,因此你无需修改 config/overleaf.rc 或 config/version。

功能

请查阅我们的文档以了解当前的功能列表。如果你希望我们添加某项功能,欢迎在 GitHub 上提交 issue(功能请求)。我们会尽力实现所请求的功能,但开发需要时间,我们无法保证每项功能都能立即交付。
欢迎贡献,但我们不保证一定会接受。我们会根据每个 PR 对底层 Overleaf 代码库的影响、维护负担以及为用户带来的价值来进行评估。我们会尽力合并并维护有价值的贡献。但是,对于引入过多更改、由未经审查或理解不足的 AI 生成代码(“vibe coding”)构成,或添加难以长期维护的功能的 PR,我们可能会拒绝。
我们通常会在发布新功能时同步更新文档。有关详细的设置说明以及可用环境变量的解释,请参阅相关文档。
Python Runner 通过 Pyodide 0.29.3 在用户的浏览器中运行 Python,而不是在服务器上运行。它会从 Pyodide 内置的软件包中加载你的代码所导入的软件包,例如 NumPy、pandas 和 Matplotlib。使用 pip 安装的软件包及其他软件包均不可用。服务器上无需进行任何配置。
不可以。拼写检查器没有日语或中文词典,因此这些语言不在拼写检查语言列表中。用户可以在编辑器设置中为项目关闭拼写检查。要防止某个单词被标记为拼写错误,请右键点击该单词并选择 Add to dictionary。添加的单词会保存到你的账户中,并应用于你的所有项目。要查看或删除这些单词,请打开编辑器设置,然后依次选择 Spelling and language → Dictionary → Edit。添加单词并不会新增拼写检查语言。
没有插件安装器。各项功能是源代码中 services/web/modules 下的模块,它们被构建进 Docker 镜像,并通过本文档中的设置启用。如需添加你自己的功能,请在源代码中添加一个模块并构建你自己的镜像。

部署

对于大多数用户,我们建议使用 Toolkit 进行部署。Kubernetes 支持尚处于实验阶段:使用 Kubernetes 展示了我们在单副本或多副本下测试过的清单,但集群会增加运维复杂度和维护工作量。沙盒编译通过 Docker socket 创建编译容器,因此每个运行 Ayakaleaf Pro 的节点都需要安装 Docker Engine。我们不提供 CRI-O、Podman 或 Quadlet 的配置。
请参阅我们的水平扩展指南。你可以部署多个 Overleaf 实例,并配置负载均衡器在它们之间分配流量。
如果你已有 Overleaf Server Pro 实例,我们很乐意帮助你迁移到 Ayakaleaf Pro。请通过电子邮件或 issue 与我们联系。
不可以。Ayakaleaf Pro 必须部署在域名的根路径下。请使用专用的域名或子域名,例如 https://overleaf.example.com。
可以。Toolkit 可以运行在 Linux、使用 Docker Desktop 的 macOS 以及使用 WSL 2 与 Docker Desktop 的 Windows 上。对于共享服务器和生产服务器,我们推荐使用 Linux。macOS 和 Windows 指南中包含沙盒编译的设置。我们不提供独立的 docker-compose.yml。要查看 Toolkit 所使用的 Compose 配置,请在 Toolkit 目录中运行 bin/docker-compose config。
没有卸载脚本。请在 Toolkit 目录中:
  1. 使用 bin/docker-compose down 停止并删除容器。
  2. 删除数据。默认情况下,数据位于 Toolkit 的 data/ 目录中。如果你在 config/overleaf.rc 中修改了 OVERLEAF_DATA_PATH、MONGO_DATA_PATH、REDIS_DATA_PATH 或 GIT_BRIDGE_DATA_PATH,也请删除这些目录。此操作无法撤销,因此如果你可能还需要这些数据,请先进行备份。
  3. 删除 Toolkit 目录。
  4. 删除 Docker 镜像(可以使用 docker images 列出):ghcr.io/ayaka-notes/overleaf-pro、git-bridge 镜像、mongo、redis 以及 TeX Live 镜像。
请在 Toolkit 目录中运行以下命令:
  • bin/stop 停止所有容器,bin/start 重新启动它们。容器会被保留,因此用户会保持登录状态。
  • bin/up -d 创建容器并在后台启动。修改 config/variables.env、config/overleaf.rc 或 config/version 后请运行它:它会重新创建配置已更改的容器,更改只有在此之后才会生效。bin/stop 和 bin/start 不会应用这些更改。
  • bin/docker-compose restart sharelatex 只重启 Overleaf 容器,不会应用配置更改。
如果每次 bin/up 重新创建容器时用户都会被退出登录,请设置 OVERLEAF_SESSION_SECRET,参见环境变量中的问答。
填写在你于服务提供方处创建的应用中,而不是 Ayakaleaf Pro 中。对于以下任何集成,config/variables.env 中都没有回调设置:Ayakaleaf Pro 会根据 OVERLEAF_SITE_URL 构建每个回调 URL 并将其发送给服务提供方,如果它与为该应用注册的 URL 不一致,服务提供方会拒绝请求。因此,你只需在服务提供方处注册该 URL,并将 OVERLEAF_SITE_URL 设置为用户打开的地址。如果你修改了 OVERLEAF_SITE_URL(例如改为新域名),也请在每个服务提供方处更新该 URL,否则关联将会失败。
默认情况下,所有数据都保存在服务器的本地磁盘上,位于 Toolkit 的 data/ 目录中:data/overleaf(项目文件、历史记录和编译输出)、data/mongo 和 data/redis。对于用户少于 1000 人的实例,我们推荐使用本地磁盘并定期进行备份。Ayakaleaf Pro 镜像约占用 5 GB。简介中所述的 40 GB 最低要求是针对沙盒编译的,其每个 texlive-full 镜像约占用 28 GB。如果不使用沙盒编译,编译会在 sharelatex 容器内运行,使用 TeX Live basic scheme 加上 latexmk、texcount、synctex、etoolbox 和 xetex,因此许多项目会因缺少宏包而编译失败。之后 data/ 目录会随着你的项目及其历史记录而增长;可使用 du -sh data/* 查看其大小。
可以,前提是 Windows 保持唤醒状态且 Docker Desktop 保持运行。开启 Start Docker Desktop when you sign in to your computer,保留 Toolkit 的 restart: always 策略,并在接通交流电源时禁用自动睡眠和休眠。屏幕可以关闭;笔记本合盖行为是另一项单独的设置。在 bin/up -d 之后关闭 Ubuntu 终端不会停止以分离模式运行的容器。退出 Docker Desktop、暂停其引擎或运行 wsl --shutdown 都会中断服务。Docker Desktop 的 Resource Saver 与 Windows 睡眠不同:它仅在没有容器运行时生效,因此正在运行的 Ayakaleaf 栈不会仅仅因为无人编辑而被视为空闲。Windows 重启后,登录时启动的设置仍需要有人登录。相关检查和恢复步骤请参阅保持实例可用。当可用性不能依赖于交互式桌面登录时,我们仍然推荐使用 Linux。
本指南使用 WSL 2 后端。它需要在 BIOS/UEFI 中启用 CPU 虚拟化、启用 Windows 的 Virtual Machine Platform(虚拟机平台)功能,以及一个可正常工作的 WSL 2 安装。完整的 Hyper-V 功能是 Docker Desktop 的另一种后端,并不是此 WSL 设置的前提条件。查看 Task Manager → Performance → CPU → Virtualization(任务管理器 → 性能 → CPU → 虚拟化),并在 PowerShell 中运行 wsl --list --verbose。0x80370102 等错误可能意味着虚拟化、该 Windows 功能或启动虚拟机监控程序已被禁用。请参阅 Windows 安装故障排除步骤,其中附有 Microsoft 和 Docker 的修复链接。启用所需功能后请重启 Windows;重新安装 Ayakaleaf 无法修复无法启动的 Docker 引擎。

LaTeX

启用沙盒编译后,每个用户的编译都会在单独的 Docker 容器中运行,并与其他用户的编译相互隔离。沙盒编译默认启用 Shell Escape。
在过去三年里,我们持续改进了用于沙盒编译的 TeX Live Full 镜像。在大多数情况下,能在 overleaf.com 上编译的项目也能在 Ayakaleaf Pro 中正确编译。如果缺少所需的字体,请手动将该字体上传到你的项目中。
请将你的项目上传到 Overleaf 官方网站,启用只读链接共享,并在 GitHub issue 中附上该链接。如果某个项目能在 Overleaf 官方网站上成功编译,却无法在 Ayakaleaf Pro 中编译,我们会调查并修复导致该问题的任何 bug。超出此范围的编译问题不在我们的支持范围内。
最后修改于 2026年11月8日