> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/installation/introduction.md).

# Introduction

Deploy Ayakaleaf Pro with guidance on migration, requirements, and LaTeX performance.

Like the Overleaf Server Pro, our Ayakaleaf Pro comes as a Docker container and is a direct drop-in replacement which additionally includes features such as SSO provided via LDAP and SAML2, improved security, tracked changes, comments, our optimized version of TeX Live, templates and administration panel.

* If you just want to test Ayakaleaf Pro's features or try out the demo, you can follow our [Using GitHub Codespace](/on-premises/installation/using-the-github-codespace.md) tutorial. The demo environment uses a minimal TeX Live installation, so some of your projects may not compile successfully.
* If you have never deployed any version of Overleaf before, please refer to [Setup Docker](/on-premises/installation/setup-docker.md) to install Docker Engine first, and then install Overleaf [Using the Toolkit](/on-premises/installation/using-the-toolkit.md).
* If you have already deployed the Community Edition of Overleaf, please refer to [Migrate from Existing](/on-premises/installation/migrate-from-existing.md) to migrate to Ayakaleaf Pro.
* If you prefer using agents like Claude or Codex, you can refer to: [Using Claude or Codex](/on-premises/installation/using-claude-or-codex.md).
* If you need to deploy in an offline or air-gapped environment, please refer to: [Air-gapped/offline deployments](/on-premises/installation/air-gapped-offline-deployments.md).
* If you are an existing Server Pro user, please open an issue to let us know before migrating to Ayakaleaf Pro, as the template data is stored in a slightly different format. We’d be very happy to help you migrate from Server Pro to Ayakaleaf Pro free of charge.
* Sometimes, if you ever get tired of our Ayakaleaf Pro and want to switch back to the official Overleaf Community Edition, that is fully supported. None of your data will be lost. For users of the official Overleaf Toolkit, simply remove your override YAML file. For users of the ayaka-notes toolkit, disable the `SERVER_PRO` option. Everything will then fall back to the standard Community Edition.

Please choose an installation method based on your needs:

{% content-ref url="/spaces/yLFrF2L1FakWXkhqpOnS/pages/W4THeswYLuFORUQh0ou0" %}
[Using GitHub Codespace](/on-premises/installation/using-the-github-codespace.md)
{% endcontent-ref %}

{% content-ref url="/spaces/yLFrF2L1FakWXkhqpOnS/pages/be58b6da3fe776295a78b5d12fa23885907a82d3" %}
[Using the Toolkit](/on-premises/installation/using-the-toolkit.md)
{% endcontent-ref %}

{% content-ref url="/spaces/yLFrF2L1FakWXkhqpOnS/pages/MMF3A9jR8GehkWoqk25I" %}
[Using Claude or Codex](/on-premises/installation/using-claude-or-codex.md)
{% endcontent-ref %}

{% content-ref url="/spaces/yLFrF2L1FakWXkhqpOnS/pages/7c04819cb0cf64fc355acd08e7a67f5d8e6c34f0" %}
[Air-gapped/offline deployments](/on-premises/installation/air-gapped-offline-deployments.md)
{% endcontent-ref %}

{% content-ref url="/spaces/yLFrF2L1FakWXkhqpOnS/pages/bh2xmBVITZpskMRrL3VL" %}
[Migrate from Existing](/on-premises/installation/migrate-from-existing.md)
{% endcontent-ref %}

### Hardware requirements

We conducted relevant tests and found that, if you run Overleaf on a 2-core, 2 GB RAM server, its core components—primarily based on Node.js—will consume approximately 1 GB of memory. Redis and MongoDB may require an additional 0.5 GB, while starting a sandboxed Docker container for compilation can consume another 0.3 GB. This means that a 2-core, 2 GB server can realistically handle only about one concurrent compilation at a time.

* The minimum hardware requirements for installing Ayakaleaf Pro are a 2-core CPU and 3 GB of RAM.
* Due to the size of our TeX Live image, at least 40 GB of storage is required to enable sandboxed compilation.
* If you want to install the complete set of TeX Live images from 2020 through 2026, please make sure you have at least 150 GB of free disk space available.

Here are some recommended hardware configurations for different usage scenarios:

| Use Case                                             | Recommended Configuration                                                                            |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| Personal use, with occasional collaboration          | 2 CPU cores, 4 GB RAM, 80 GB storage                                                                 |
| Small teams, up to 10 users with light collaboration | 2 CPU cores, 8 GB RAM, 256 GB storage                                                                |
| Medium-sized teams, up to 100 users                  | 4 CPU cores, 16 GB RAM, 1 TB storage                                                                 |
| Large-scale or university deployments                | Distributed cluster deployment, with S3 storage; please contact us if you need deployment assistance |

### Software requirements

For software requirements, we recommend using a recent version of Ubuntu (Ubuntu 24.04) together with the latest stable version of Docker.

We do not recommend deploying Ayakaleaf Pro on Windows or other unsupported operating systems like CentOS, as you may encounter compatibility issues or unexpected problems during installation and operation.

But if you would like to try deploying Ayakaleaf Pro on ARM-based systems or macOS, we welcome you to share your experience and feedback with the community.

### LaTeX Performance

LaTeX is a single threaded program, meaning it can only utilize one CPU core at a time. When compiling a single document, performance is primarily limited by the CPU's single-core clock speed. Therefore the faster the single core performance of your CPU the faster you will be able to compile a document. More CPU cores are only beneficial when multiple users are compiling documents concurrently.

Using the [ThuThesis template](https://www.overleaf.com/latex/templates/thuthesis-tsinghua-university-thesis-latex-template/cfwgcxtvkbsx) as an example, the compilation time is about 6 seconds on an Intel Core i9-14900K (5.6 GHz), while it takes about 13 seconds on an Azure Standard D2as v5 instance (2 vCPUs, 8 GiB RAM) powered by an AMD EPYC 7763 (3.2 GHz).

Of course, actual compilation performance depends on your hardware configuration. Most server CPUs do not run at such high clock speeds as 14900K, so you will need to make a trade-off between cost and compilation speed.

Meanwhile, we have also conducted an in-depth analysis of LaTeX compilation performance. If you are interested, please refer to our blog [Overleaf Benchmark: A Deep Research of Concurrent LaTeX Compilation in Overleaf (SaaS and Self-host)](/blog/2026/overleaf-benchmark.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ayakaleaf-pro.ayaka.space/on-premises/installation/introduction.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
