从现有部署迁移

将现有的 Overleaf Toolkit 部署迁移到 Ayakaleaf Pro。

在每次主版本迁移之前，务必进行一次一致性备份，以便在需要时能够回滚。

​

从 Overleaf 社区版迁移

​

情况 01：从 Overleaf Toolkit 迁移

如果你正在为 Overleaf 社区版使用官方 Overleaf Toolkit，只需在 overleaf-toolkit/config 目录中添加一个名为 docker-compose.override.yml 的文件，内容如下或类似：

docker-compose.override.yml

---
services:
    sharelatex:
        image: ghcr.io/ayaka-notes/overleaf-pro:X.x.x # change to specific version

运行以下命令启动实例：

bin/up

就是这样！一切准备就绪。接下来，你可以验证 Ayakaleaf 实例是否正常运行，以及能否访问 Web 界面。一切正常后，继续执行下面的配置步骤，以启用以下高级功能：

• sandboxed-compiles.md
• authentication
• github-synchronisation.md
• zotero-integration.md

​

情况 02：从 Docker Compose 文件迁移

如果你使用的是独立的 docker-compose.yml，请先将其迁移到 Overleaf Toolkit。Toolkit 可以简化本地部署的安装、升级和维护。

按照 docker-compose.yml-to-toolkit-migration.md 转换你现有的部署。在迁移过程中，请保留当前的配置和数据卷路径。

Toolkit 部署运行后，按照 #from-overleaf-toolkit 将其镜像切换为 Ayakaleaf Pro。使用 bin/up 启动实例，然后确认你可以访问 Web 界面。

---

​

从 Overleaf Server Pro 迁移

如果你目前运行的是商业授权的 Overleaf Server Pro 实例，并希望迁移到 Ayakaleaf Pro，请注意迁移可能需要一些额外工作，因为某些数据格式（templates）可能并不完全兼容。不过，我们很乐意为你提供帮助。请提交 issue 或通过 [e-mail] 联系我们，我们将免费帮助你迁移到 Ayakaleaf Pro。

---

​

从 Overleaf CEP 迁移

我们经常收到用户询问能否从 Overleaf CEP 迁移到 Ayakaleaf Pro。在大多数情况下，Overleaf CEP 和 Ayakaleaf Pro 提供的功能大致相当，并且截至 6.2.0 版本仍保持数据兼容。两个项目发布功能的时间可能不同；例如，我们可能会从 Overleaf CEP 中 cherry-pick 某个功能，反之亦然。尽管我们对同一功能的实现可能略有不同，但通常没有令人信服的迁移理由。

如果你仍然希望迁移到或试用 Ayakaleaf Pro，请参阅：#case-01-from-overleaf-toolkit。迁移过程是相同的。

---

​

从 Overleaf SaaS 迁移

遗憾的是，从 Overleaf SaaS 平台迁移到自托管的 Ayakaleaf Pro 实例可能要困难得多。目前，唯一普遍可用的方法是将每个项目下载为 ZIP 压缩包，然后上传到你自托管的 Ayakaleaf Pro 实例。这只会迁移当前的项目文件，这意味着你将_丢失_：

• 所有项目历史和以前的修订版本
• 所有评论和修订跟踪
• 所有 Git 元数据和提交历史
• 所有 GitHub 同步链接和设置
• BibTeX 文件与第三方文献管理平台之间的所有链接

---

​

从第三方 Overleaf 分支迁移

Ayakaleaf Pro 可能不支持某个第三方 Overleaf 分支所特有的功能。一旦某个分支与上游 Overleaf 代码库出现显著分歧，或者在引入更改时未保持与上游的兼容性，合并后续的 Overleaf 版本就会变得极其困难。你仍然可以尝试上述迁移方法，但无法保证兼容性，并且我们可能无法为来自不受支持分支的迁移提供协助或技术支持。