既存環境からの移行

既存の 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 インスタンスが正しく動作しており、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 時点ではデータの互換性が保たれています。2 つのプロジェクトは異なるタイミングで機能をリリースすることがあります。例えば、私たちが 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 リリースをマージすることが非常に困難になる可能性があります。上記の移行方法を試すことはできますが、互換性は保証されず、サポート対象外のフォークからの移行については支援や技術サポートを提供できない場合があります。