> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overleaf インポート API

> 他の Web サイトから LaTeX スニペットやプロジェクトを Kubernetes デプロイで開けるようにします。

インポート API（`/docs` と「Open in Ayakaleaf」ボタン、`open-in-overleaf` モジュール）は、すべての Ayakaleaf Pro Pod の **web** サービスで動作し、デフォルトで有効になっています。URL で指定されたファイルは、同じ Pod 内の linked-url-proxy を通じてダウンロードされます。呼び出し方は [Overleaf インポート API](https://ayakaleaf-pro.mintlify.site/ja/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md)で説明しています。

| | |
| - | - |
| サービス | web（`open-in-overleaf` モジュール）。ダウンロードは linked-url-proxy 経由 |
| 外部 → Overleaf | 任意の Web サイトからブラウザーが `${OVERLEAF_SITE_URL}/docs` に `GET` または `POST` |
| Pod → 外部 | `snip_uri` と `zip_uri` のダウンロード。[外部 URL](https://ayakaleaf-pro.mintlify.site/ja/on-premises/configuration/kubernetes/external-url.md)で説明する制限を受ける |
| 状態 | ログインしていない訪問者のリクエスト。ログインするまで Redis に 10 分間保持される |
| 定期ジョブ | なし |

### 設定

有効化に必要な設定はありません。ConfigMap の関連設定:

| 設定 | |
| - | - |
| `OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"` | ログインしていない訪問者が `/devs` を開けるようになり、送信したリクエストはログインするまで保持されます。[パブリックアクセス](https://ayakaleaf-pro.mintlify.site/ja/on-premises/configuration/kubernetes/authentication/public-access.md)を参照してください。 |
| `MAX_UPLOAD_SIZE` | 1 つのリクエストで送信できる ZIP の最大サイズ（MB 単位、デフォルトは `50`）。Ingress やロードバランサーもそのサイズのリクエストボディを受け付ける必要があります。 |
| `OVERLEAF_LINKED_URL_*` | `snip_uri` と `zip_uri` が指すことのできるアドレス。[外部 URL](https://ayakaleaf-pro.mintlify.site/ja/on-premises/configuration/kubernetes/external-url.md)を参照してください。 |

### 複数のレプリカ

追加の設定は不要です。ログインしていない訪問者のリクエストは Redis に保持されるため、ログイン後に訪問者がどのレプリカにアクセスしても再開されます。

### Kubernetes でのテスト

Kubernetes 1.37 上でレプリカ 1 つの状態で、インポート API のエンドツーエンドテスト（14 ケース）に合格しています。対象は、`/devs` ページとそのサンプルプロジェクト、スニペット・完全なドキュメント・URL エンコードされたリンク・データ URL のファイルからのプロジェクト作成、プロジェクトにできない送信の拒否、内部アドレスからのダウンロードの拒否、ログインを経ても保持される未ログイン時の送信とリンク、そして `OVERLEAF_ALLOW_PUBLIC_ACCESS` を有効にした場合の未ログイン訪問者向けの `/devs` と、ログイン後に一度だけ再開される送信済みスニペットです。最後のケースは HAProxy の背後に 3 つのレプリカを置いた状態でも合格しています。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.