Basic Question
Q01: Is Ayakaleaf Pro a free trial? Does it require a license?
Q01: Is Ayakaleaf Pro a free trial? Does it require a license?
Q02: Do you (ayakaleaf pro) include all Overleaf Server Pro features?
Q02: Do you (ayakaleaf pro) include all Overleaf Server Pro features?
Q03: How much does Overleaf Server Pro cost?
Q03: How much does Overleaf Server Pro cost?
Q04: Why does Overleaf Server Pro not include GitHub Sync or AI features?
Q04: Why does Overleaf Server Pro not include GitHub Sync or AI features?
Q05: Is Ayakaleaf Pro secure and reliable?
Q05: Is Ayakaleaf Pro secure and reliable?
Q06: Will Ayakaleaf Pro be maintained long term?
Q06: Will Ayakaleaf Pro be maintained long term?
Q07: Is Ayakaleaf Pro compliant?
Q07: Is Ayakaleaf Pro compliant?
Q08: Why is the project called Ayakaleaf Pro?
Q08: Why is the project called Ayakaleaf Pro?
Q09: What distinguishes Ayakaleaf Pro from newer AI-built LaTeX editors?
Q09: What distinguishes Ayakaleaf Pro from newer AI-built LaTeX editors?
Q10: What happened to the GitHub repository ayaka-notes/overleaf-pro?
Q10: What happened to the GitHub repository ayaka-notes/overleaf-pro?
ayaka-notes/overleaf-pro links and Git remotes to the new name. The Docker image keeps its name, ghcr.io/ayaka-notes/overleaf-pro, so you do not need to change config/overleaf.rc or config/version.Features
Q01: What features does Ayakaleaf Pro offer? Can I request a new feature?
Q01: What features does Ayakaleaf Pro offer? Can I request a new feature?
Q02: I’ve built some features. Can I submit a PR, and is it guaranteed to be accepted?
Q02: I’ve built some features. Can I submit a PR, and is it guaranteed to be accepted?
Q03: How do I configure a specific feature?
Q03: How do I configure a specific feature?
Q04: Which Python libraries can the Python Runner use?
Q04: Which Python libraries can the Python Runner use?
pip and other packages are not available. There is nothing to configure on the server.Q05: Can spell checking check Japanese or Chinese?
Q05: Can spell checking check Japanese or Chinese?
Q06: Can I add plugins?
Q06: Can I add plugins?
services/web/modules of the source code, built into the Docker image and turned on with the settings in this documentation. To add your own, add a module to the source code and build your own image.Deployment
Q01: Does Ayakaleaf Pro support distributed deployment in k8s?
Q01: Does Ayakaleaf Pro support distributed deployment in k8s?
Q02: How can I ensure availability when serving thousands of users?
Q02: How can I ensure availability when serving thousands of users?
Q03: Can you help me deploy or migrate?
Q03: Can you help me deploy or migrate?
Q04: Can I host Ayakaleaf Pro under a URL sub-path, like https://example.com/overleaf?
Q04: Can I host Ayakaleaf Pro under a URL sub-path, like https://example.com/overleaf?
https://overleaf.example.com.Q05: Can I run Ayakaleaf Pro on Windows or macOS, or without the Toolkit?
Q05: Can I run Ayakaleaf Pro on Windows or macOS, or without the Toolkit?
docker-compose.yml. To see the Compose configuration that the Toolkit uses, run bin/docker-compose config in the Toolkit directory.Q06: How do I uninstall Ayakaleaf Pro?
Q06: How do I uninstall Ayakaleaf Pro?
- Stop and remove the containers with
bin/docker-compose down. - Delete the data. By default it is in the
data/directory of the Toolkit. If you changedOVERLEAF_DATA_PATH,MONGO_DATA_PATH,REDIS_DATA_PATHorGIT_BRIDGE_DATA_PATHinconfig/overleaf.rc, delete those directories too. This cannot be undone, so back up first if you may need the data. - Delete the Toolkit directory.
- Remove the Docker images, which you can list with
docker images:ghcr.io/ayaka-notes/overleaf-pro, the git-bridge image,mongo,redisand the TeX Live images.
Q07: How do I stop, start or restart Ayakaleaf Pro?
Q07: How do I stop, start or restart Ayakaleaf Pro?
bin/stopstops all containers,bin/startstarts them again. The containers are kept, so users stay logged in.bin/up -dcreates the containers and starts them in the background. Run it after changingconfig/variables.env,config/overleaf.rcorconfig/version: it recreates the containers whose configuration changed, and only then do the changes take effect.bin/stopandbin/startdo not apply them.bin/docker-compose restart sharelatexrestarts only the Overleaf container, without applying configuration changes.
bin/up recreates the container, set OVERLEAF_SESSION_SECRET, see the Q&A in Environment Variables.Q08: Where do I put the OAuth callback URL?
Q08: Where do I put the OAuth callback URL?
config/variables.env for any of these integrations: Ayakaleaf Pro builds every callback URL from OVERLEAF_SITE_URL and sends it to the provider, which rejects it unless it matches the one registered for the application. So you only register it at the provider, and set OVERLEAF_SITE_URL to the address users open.OVERLEAF_SITE_URL, for example to a new domain, update the URL at every provider too, or linking fails.Q09: Where is the data stored, and how much disk space do I need?
Q09: Where is the data stored, and how much disk space do I need?
data/ directory: data/overleaf (project files, history and compile output), data/mongo and data/redis. For instances with fewer than 1000 users, local disk with regular backups is what we recommend.The Ayakaleaf Pro image takes about 5 GB. The 40 GB minimum in the Introduction is for Sandboxed Compiles, whose texlive-full images take about 28 GB each. Without Sandboxed Compiles, compiles run inside the sharelatex container with the TeX Live basic scheme plus latexmk, texcount, synctex, etoolbox and xetex, so many projects fail with missing packages. The data/ directory then grows with your projects and their history; check it with du -sh data/*.Q10: Can I keep Ayakaleaf running on Windows 24 hours a day?
Q10: Can I keep Ayakaleaf running on Windows 24 hours a day?
restart: always policies, and disable automatic sleep and hibernation while on AC power. The screen can turn off; laptop lid behavior is a separate setting. Closing the Ubuntu terminal after bin/up -d does not stop detached containers. Quitting Docker Desktop, pausing its engine or running wsl --shutdown interrupts the service.Docker Desktop’s Resource Saver is different from Windows sleep: it applies when no containers are running, so a running Ayakaleaf stack is not idle merely because nobody is editing. After a Windows reboot, the login startup setting still requires someone to sign in. Follow Keep the instance available for the checks and recovery steps. Linux remains our recommendation when availability must not depend on an interactive desktop login.Q11: Docker Desktop says virtualization is disabled. Do I need Hyper-V?
Q11: Docker Desktop says virtualization is disabled. Do I need Hyper-V?
wsl --list --verbose in PowerShell. Errors such as 0x80370102 can mean virtualization, the Windows feature or the boot hypervisor is disabled. See the Windows installation troubleshooting steps, with Microsoft’s and Docker’s repair links. Restart Windows after enabling the required features; reinstalling Ayakaleaf cannot fix a Docker engine that does not start.LaTeX
Q01: Are users’ LaTeX project compilations isolated? Is Shell Escape enabled?
Q01: Are users’ LaTeX project compilations isolated? Is Shell Escape enabled?
Q02: Is the Sandbox Compiles image reliable? Can compilation fail?
Q02: Is the Sandbox Compiles image reliable? Can compilation fail?
Q03: My project won’t compile. Can you help me troubleshoot it?
Q03: My project won’t compile. Can you help me troubleshoot it?

