從既有部署遷移

將既有的 Overleaf Toolkit 部署遷移至 Ayakaleaf Pro。

請務必在每次主要版本遷移之前進行一致性備份，以便在必要時能夠回復。

​

從 Overleaf Community 遷移

​

情況 01：從 Overleaf Toolkit 遷移

如果您使用的是 Overleaf Community 的官方 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 執行個體是否正常運作，以及是否能存取網頁介面。一切正常後，請繼續進行下方的設定步驟，以啟用以下進階功能：

• 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 啟動執行個體，然後確認您可以存取網頁介面。

---

​

從 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 中繼資料與 commit 歷史記錄
• 所有 GitHub 同步連結與設定
• 所有 BibTeX 檔案與第三方文獻管理平台之間的連結

---

​

從第三方 Overleaf 分支遷移

Ayakaleaf Pro 可能不支援特定第三方 Overleaf 分支專屬的功能。一旦某個分支與上游 Overleaf 程式碼庫大幅分歧，或在未維持上游相容性的情況下引入變更，要合併後續的 Overleaf 版本就可能變得極為困難。您仍可嘗試上述的遷移方法，但無法保證相容性，而且對於從不受支援的分支進行的遷移，我們可能無法提供協助或技術支援。