Naar hoofdinhoud gaan
Ayakaleaf Pro biedt de mogelijkheid om compilaties uit te voeren in een beveiligde sandboxomgeving, voor beveiliging op enterpriseniveau. Dit gebeurt door elk project in een eigen beveiligde Docker-omgeving te draaien.

Verbeterde beveiliging

Sandboxed Compiles zijn de aanbevolen aanpak voor Ayakaleaf Pro, omdat veel LaTeX-documenten tijdens het compileren naar pdf willekeurige shellcommando’s moeten of kunnen uitvoeren. Als je Sandboxed Compiles gebruikt, draait elke compilatie in een aparte Docker-container met beperkte rechten, die niet wordt gedeeld met andere gebruikers of projecten en geen toegang heeft tot externe resources zoals het hostnetwerk.
Als je Ayakaleaf Pro zonder Sandboxed Compiles probeert te draaien, wordt de compilatie samen met andere gelijktijdige compilaties uitgevoerd in de hoofdcontainer van Docker, en hebben gebruikers tijdens het compileren van LaTeX volledige lees- en schrijftoegang tot de resources van de sharelatex-container (bestandssysteem, netwerk en omgevingsvariabelen).

Eenvoudiger pakketbeheer

Om te voorkomen dat je pakketten handmatig moet installeren, raden we aan Sandboxed Compiles in te schakelen. Dit is een configureerbare instelling binnen Ayakaleaf Pro die je gebruikers toegang geeft tot dezelfde TeX Live-omgeving als op overleaf.com, maar dan binnen je eigen on-premise installatie. De TeX Live-images die door Sandboxed Compiles worden gebruikt, bevatten de populairste pakketten en lettertypen, getest met onze galerijsjablonen, wat zorgt voor maximale compatibiliteit met on-premise projecten. Door Sandboxed Compiles in te schakelen, kun je bepalen uit welke TeX Live-versies gebruikers binnen hun project kunnen kiezen, en kun je een standaardversie van de TeX Live-image instellen voor nieuwe projecten.
Als je Ayakaleaf Pro zonder Sandboxed Compiles probeert te draaien, gebruikt je instantie standaard een basisschemaversie van TeX Live voor compilaties. Deze basisversie is lichtgewicht en bevat slechts een zeer beperkte subset van LaTeX-pakketten, wat waarschijnlijk leidt tot fouten over ontbrekende pakketten bij je gebruikers, vooral als ze kant-en-klare sjablonen proberen te gebruiken.
Omdat Ayakaleaf Pro is ontworpen om offline te werken, is er geen geautomatiseerde manier om galerijsjablonen van overleaf.com in je on-premise installatie te integreren; het is echter wel mogelijk om dit handmatig per sjabloon te doen. Raadpleeg voor meer informatie onze handleiding over het overzetten van sjablonen van overleaf.com: #transferring-templates-from-overleaf.com.
Sandboxed Compiles vereist dat de sharelatex-container toegang heeft tot de Docker-socket op de hostmachine (via een bind mount), zodat deze de naastgelegen compilatiecontainers kan beheren.

Hoe het werkt

Wanneer Sandboxed Compiles is ingeschakeld, wordt de Docker-socket van de hostmachine in de sharelatex-container gemount, zodat de compilerservice in de container nieuwe Docker-containers op de host kan aanmaken. Vervolgens doet de LaTeX-compilerservice (CLSI) bij elke compilatie van elk project het volgende:
  • De projectbestanden wegschrijven naar een locatie binnen OVERLEAF_DATA_PATH.
  • Via de gemounte Docker-socket een nieuwe texlive-container aanmaken voor de compilatie.
  • De texlive-container de projectgegevens laten lezen vanaf de locatie onder OVERLEAF_DATA_PATH.
  • Het project compileren binnen de texlive-container.

Sandboxed Compiles inschakelen

Voor Toolkit-gebruikers

Om Sandboxed Compiles (ook wel Sibling containers genoemd) in te schakelen, stel je de volgende configuratieopties in overleaf-toolkit/config/overleaf.rc in:
config/overleaf.rc
Om ze uit te schakelen, stelt u SIBLING_CONTAINERS_ENABLED=false in en voert u bin/up uit. Compilaties draaien dan in de sharelatex-container met de basisversie van TeX Live.

Voor Docker Compose-gebruikers

De TeX Live-image instellen

Gebruikers op het Chinese vasteland kunnen de images ophalen van de mirror ghcr.nju.edu.cn om het downloaden te versnellen, en ze vervolgens taggen met hun ghcr.io-naam:
Gebruik ghcr.nju.edu.cn NIET in de omgevingsinstellingen van je Toolkit: houd daar de ghcr.io-namen aan. Om te voorkomen dat bin/up de images opnieuw van ghcr.io ophaalt, stel je SIBLING_CONTAINERS_PULL=false in in config/overleaf.rc. Om de images via de mirror up-to-date te houden, zie TeX Live Full-images automatisch bijwerken.
Ayakaleaf Pro gebruikt drie omgevingsvariabelen om te bepalen welke TeX Live-images voor Sandboxed Compiles worden gebruikt:
  • TEX_LIVE_DOCKER_IMAGE (optioneel), De TeX Live-image die door nieuwe projecten wordt gebruikt. Deze moet een van de images in ALL_TEX_LIVE_DOCKER_IMAGES zijn. Als deze niet is ingesteld, gebruiken nieuwe projecten de eerste image in ALL_TEX_LIVE_DOCKER_IMAGES.
  • ALL_TEX_LIVE_DOCKER_IMAGE_NAMES (optioneel), Een kommagescheiden lijst met namen voor de images, in dezelfde volgorde, die in de compilerinstellingen worden getoond. Als deze niet is ingesteld, of korter is dan de lijst met images, wordt een image getoond met zijn tag, bijvoorbeeld 2026.1.
  • ALL_TEX_LIVE_DOCKER_IMAGES (verplicht), Een kommagescheiden lijst met te gebruiken TeX Live-images. Als de Overleaf Toolkit voor de deployment wordt gebruikt, worden deze images gedownload of bijgewerkt. Stel SIBLING_CONTAINERS_PULL=false in config/overleaf.rc in om het downloaden over te slaan.
Wanneer je je Ayakaleaf Pro-instantie start met het commando bin/up, pullt de Toolkit automatisch alle images die in ALL_TEX_LIVE_DOCKER_IMAGES staan. Hier is een voorbeeld waarin we voor nieuwe projecten standaard TeX Live 2026 gebruiken en 2025 behouden voor oude projecten.
De volgende configuratie installeert alle volledige TeX Live Docker-images van 2025 tot en met 2026. We raden aan minimaal 64 GB vrije opslagruimte te hebben voordat je deze configuratie gebruikt.
config/variables.env
Het wordt sterk aanbevolen om minimaal 2 texlive-full-images in te stellen. Zie #known-issues voor de gedetailleerde reden.

Beschikbare TeX Live-images

Dit is een reeks TeX Live-images die speciaal voor Overleaf zijn geoptimaliseerd en die ook aan TEX_LIVE_DOCKER_IMAGE en ALL_TEX_LIVE_DOCKER_IMAGES kunnen worden toegevoegd:
  • ghcr.io/ayaka-notes/texlive-full:2026.1 (ook de tag latest)
  • ghcr.io/ayaka-notes/texlive-full:2025.1
  • ghcr.io/ayaka-notes/texlive-full:2024.1
  • ghcr.io/ayaka-notes/texlive-full:2023.1
  • ghcr.io/ayaka-notes/texlive-full:2022.1
  • ghcr.io/ayaka-notes/texlive-full:2021.1
  • ghcr.io/ayaka-notes/texlive-full:2020.1
Er geldt een strikt schema voor hoe images getagd moeten worden (de volgende regex is van toepassing: ^[0-9]+.[0-9]+, waarbij het eerste getal het TeX Live-jaar bepaalt en het tweede de patchversie).

Kan ik een andere image-registry gebruiken?

Sommigen vragen zich misschien af of ze ghcr.io kunnen vervangen door een andere mirrorsite, of texlive kunnen vervangen door een andere image van Docker Hub?
Nee, dat raden we niet aan, omdat de configuratie relatief ingewikkeld is. Als je vanaf een mirrorsite downloadt, kun je je image hernoemen naar ghcr.io/ayaka-notes/texlive-full. Maar als je echt je eigen image-registry wilt gebruiken, voeg dan het volgende toe:
config/variables.env
Vervolgens moet je ervoor zorgen dat alle texlive-images in your-repo staan, zoals
  • hub.your.com/your-repo/texlive-full:2025.1
  • hub.your.com/your-repo/texlive-full:2024.1
Lees voor meer informatie de onderstaande broncode om te begrijpen hoe we je omgevingsvariabele parsen:
sandboxed-compiles/index.mjs

Geautomatiseerde synchronisatie van TeX Live-images

Om te voorkomen dat je je instantie elke keer handmatig met bin/up moet bijwerken, kun je updates van je TeX Live-image automatiseren. Zie updating-tex-live-full-images-automatically.md.

Bekende problemen

Dit is een echte casus uit de Overleaf-community:
Met 6.0.1-ext-v3.3 heb ik deze instellingen in variables.env:
Dit werkt prima met texlive/texlive:latest-full. Ik heb echter een andere texlive-image danteev/texlive:2025-10-15 gepulld en beide variabelen gewijzigd naar de nieuwe imagenaam, maar het werkt niet:
In de logs zie ik het volgende:
Het lijkt erop dat de bijgewerkte instellingen in variables.env niet worden toegepast. De compilatie probeert nog steeds de image texlive/texlive:latest-full te draaien, niet de nieuwe image. Ik heb geprobeerd opnieuw op te starten, de containers te verwijderen en opnieuw te starten, maar het probleem blijft hetzelfde. Heeft iemand een oplossing?
Door enkele technische beperkingen geldt het volgende: als je slechts één Docker TeXLive-image instelt, zoals texlive-fullA:latest
En je na een tijdje met je Overleaf-instantie te hebben gewerkt de TeXLive-image wilt wijzigen naar texlive-fullB:latest, dan zul je merken dat je gebruikers geen enkel project meer kunnen compileren.
Dit komt doordat de naam van de TeXLive-Full-image (voor sandbox-compilatie) van elk project in de database wordt opgeslagen. Alleen wanneer een gebruiker de TeXLive-versie van zijn project wijzigt, bijvoorbeeld van 2024 naar 2025, wordt de imagenaam in de database aangepast. Wanneer CLSI een project compileert, gebruikt het de containerimagenaam uit de database om het project direct te compileren. Als je slechts één Docker-image aanbiedt, kunnen gebruikers de image waarmee hun project wordt gecompileerd niet wijzigen. In dat geval moet je een script schrijven om de TeXLive-image voor alle gebruikersprojecten in MongoDB handmatig aan te passen.

Debuggen en melden

Voer het volgende commando uit om de clsi-log vanuit de Toolkit te bekijken:
Als je problemen ondervindt bij het compileren met de TeX Live-images, meld dan hier een issue: https://github.com/ayaka-notes/texlive-full/issues/new?template=texlive-image-bug.yml Om ons te helpen het probleem te reproduceren en op te lossen, kan je worden gevraagd je project naar Overleaf te uploaden. We pullen het project dan en voeren compilatietests uit met GitHub Action.

Vragen en antwoorden

Antwoord: De containers en compilatiebestanden wel, na enige tijd; de TeX Live-images niet.
  • Compilatiecontainers (project-<project id>-<hash>) worden hergebruikt bij compilaties van hetzelfde project, dus ze blijven na een compilatie bestaan. Elk uur wordt er een controle uitgevoerd die de containers verwijdert die ouder zijn dan een uur en waarvan het project het afgelopen uur niet is gecompileerd. Een container is meestal een tot twee uur na de laatste compilatie verdwenen. Overleaf herstarten verwijdert ze niet; de volgende controle van het uur wel.
  • Containers voor woordentelling, SyncTeX en conversie worden verwijderd zodra ze klaar zijn.
  • Compilatiebestanden (data/overleaf/data/compiles en output) worden verwijderd zodra een project een dag niet is gebruikt, wat elke 10 minuten wordt gecontroleerd. Wanneer de schijfruimte opraakt, wordt deze periode stapsgewijs verkort, tot een halve dag.
  • TeX Live-images worden nooit verwijderd, omdat elke compilatie ze nodig heeft. Om ruimte vrij te maken nadat je een image uit ALL_TEX_LIVE_DOCKER_IMAGES hebt verwijderd, verwijder je deze met docker image rm <image>.
Het is niet nodig om deze containers handmatig te verwijderen.
Antwoord: Nee. Elke compilatiecontainer koppelt alleen de compilatiemap van zijn eigen project, op /compile, en heeft geen netwerk, en er is geen instelling om andere hostmappen erin te koppelen. Upload in plaats daarvan de bestanden die het project nodig heeft naar het project.
Antwoord: Ja. ghcr.io/ayaka-notes/texlive-basic:<year>.1 (2020.1 tot en met 2026.1) bevat het TeX Live basic-schema plus enkele pakketten zoals latexmk, xetex en fontspec, zonder de volledige lettertypeset. Het is veel kleiner dan texlive-full, maar projecten die andere pakketten gebruiken, krijgen foutmeldingen over ontbrekende pakketten. Voor TeX Live 2025 basic:
config/variables.env
ghcr.io/ayaka-notes/texlive-full:base is geen basic-image: het bevat geen TeX Live en kan niet compileren.
Antwoord: De editor toont dit niet, en het clsi-log registreert het alleen op debugniveau. Elk compilatieverzoek geeft het echter terug: open de ontwikkelaarstools van de browser, ga naar het tabblad Network, compileer opnieuw en selecteer het compile-verzoek. Het JSON-antwoord bevat timings in milliseconden, waarbij compileE2E de volledige compilatie in de compilatieservice is en compile de LaTeX-run zelf.
Laatst gewijzigd op 13 november 2026