Hopp til hovedinnhold
Ayakaleaf Pro gir deg muligheten til å kjøre kompileringer i et sikret sandkassemiljø for sikkerhet på bedriftsnivå. Dette gjøres ved å kjøre hvert prosjekt i sitt eget sikrede Docker-miljø.

Forbedret sikkerhet

Sandboxed Compiles er den anbefalte tilnærmingen for Ayakaleaf Pro, fordi mange LaTeX-dokumenter krever eller har muligheten til å kjøre vilkårlige skallkommandoer som en del av PDF-kompileringen. Hvis du bruker Sandboxed Compiles, kjøres hver kompilering i en egen Docker-container med begrensede rettigheter som ikke deles med noen annen bruker eller noe annet prosjekt, og som ikke har tilgang til eksterne ressurser som vertsnettverket.
Hvis du forsøker å kjøre Ayakaleaf Pro uten Sandboxed Compiles, kjøres kompileringen side om side med andre samtidige kompileringer inne i hoved-Docker-containeren, og brukerne har full lese- og skrivetilgang til ressursene i sharelatex-containeren (filsystem, nettverk og miljøvariabler) når de kjører LaTeX-kompileringer.

Enklere pakkehåndtering

For å slippe å installere pakker manuelt anbefaler vi å aktivere Sandboxed Compiles. Dette er en konfigurerbar innstilling i Ayakaleaf Pro som gir brukerne dine tilgang til det samme TeX Live-miljøet som på overleaf.com, men i din egen lokale installasjon. TeX Live-imagene som brukes av Sandboxed Compiles inneholder de mest populære pakkene og skrifttypene, testet mot malene i galleriet vårt, noe som sikrer maksimal kompatibilitet med lokale prosjekter. Når du aktiverer Sandboxed Compiles, kan du konfigurere hvilke TeX Live-versjoner brukerne kan velge mellom i prosjektene sine, og angi en standardversjon av TeX Live-imaget for nye prosjekter.
Hvis du forsøker å kjøre Ayakaleaf Pro uten Sandboxed Compiles, vil instansen som standard bruke en versjon av TeX Live med basic-skjemaet til kompileringer. Denne grunnversjonen er lett og inneholder bare et svært begrenset utvalg LaTeX-pakker, noe som mest sannsynlig vil føre til feil om manglende pakker for brukerne dine, særlig hvis de prøver å bruke ferdige maler.
Siden Ayakaleaf Pro er utformet for å fungere uten nettforbindelse, finnes det ingen automatisk måte å integrere galleriets maler fra overleaf.com i den lokale installasjonen; det er imidlertid mulig å gjøre dette manuelt for hver mal. For mer informasjon om hvordan dette fungerer, se veiledningen vår om overføring av maler fra overleaf.com: #transferring-templates-from-overleaf.com.
Sandboxed Compiles krever at sharelatex-containeren har tilgang til Docker-socketen på vertsmaskinen (via en bind mount), slik at den kan administrere disse søskencontainerne for kompilering.

Slik fungerer det

Når Sandboxed Compiles er aktivert, monteres Docker-socketen fra vertsmaskinen inn i sharelatex-containeren, slik at kompileringstjenesten i containeren kan opprette nye Docker-containere på verten. Deretter gjør LaTeX-kompileringstjenesten (CLSI) følgende for hver kompilering i hvert prosjekt:
  • Skriver prosjektfilene til en plassering inne i OVERLEAF_DATA_PATH.
  • Bruker den monterte Docker-socketen til å opprette en ny texlive-container for kompileringen.
  • Lar texlive-containeren lese prosjektdataene fra plasseringen under OVERLEAF_DATA_PATH.
  • Kompilerer prosjektet inne i texlive-containeren.

Aktivere Sandboxed Compiles

For Toolkit-brukere

For å aktivere Sandboxed Compiles (også kjent som søskencontainere, Sibling containers) angir du følgende konfigurasjonsvalg i overleaf-toolkit/config/overleaf.rc:
config/overleaf.rc
For å slå dem av setter du SIBLING_CONTAINERS_ENABLED=false og kjører bin/up. Kompileringer kjører da i containeren sharelatex med dens grunnleggende TeX Live.

For Docker Compose-brukere

Sette opp TeX Live-imaget

Brukere i Fastlands-Kina kan hente imagene fra speilet ghcr.nju.edu.cn for å få raskere nedlasting, og deretter tagge dem med ghcr.io-navnet sitt:
IKKE bruk ghcr.nju.edu.cn i miljøinnstillingene til Toolkit: behold ghcr.io-navnene der. For å hindre at bin/up henter imagene fra ghcr.io på nytt, angir du SIBLING_CONTAINERS_PULL=false i config/overleaf.rc. For å holde imagene oppdatert via speilet, se Updating TeX Live Full Images Automatically.
Ayakaleaf Pro bruker tre miljøvariabler for å bestemme hvilke TeX Live-images som skal brukes til Sandboxed Compiles:
  • TEX_LIVE_DOCKER_IMAGE (valgfri), TeX Live-imaget som brukes av nye prosjekter. Det må være ett av imagene i ALL_TEX_LIVE_DOCKER_IMAGES. Hvis den ikke er satt, bruker nye prosjekter det første imaget i ALL_TEX_LIVE_DOCKER_IMAGES.
  • ALL_TEX_LIVE_DOCKER_IMAGE_NAMES (valgfri), En kommaseparert liste med navn på imagene, i samme rekkefølge, som vises i kompilatorinnstillingene. Hvis den ikke er satt, eller er kortere enn listen over images, vises et image med taggen sin, for eksempel 2026.1.
  • ALL_TEX_LIVE_DOCKER_IMAGES (påkrevd), En kommaseparert liste med TeX Live-images som skal brukes. Hvis Overleaf Toolkit brukes til distribusjonen, blir disse imagene lastet ned eller oppdatert. For å hoppe over nedlastingen, angi SIBLING_CONTAINERS_PULL=false i config/overleaf.rc.
Når du starter Ayakaleaf Pro-instansen med kommandoen bin/up, henter Toolkit automatisk alle imagene som er oppført i ALL_TEX_LIVE_DOCKER_IMAGES. Her er et eksempel der vi bruker TeX Live 2026 som standard for nye prosjekter, og beholder 2025 for gamle prosjekter.
Følgende konfigurasjon installerer alle fullstendige TeX Live Docker-images fra 2025 til 2026. Vi anbefaler at du har minst 64 GB ledig lagringsplass før du bruker denne konfigurasjonen.
config/variables.env
Det anbefales sterkt å sette opp minst 2 texlive-full-images. For en detaljert begrunnelse, se #known-issues

Tilgjengelige TeX Live-images

Dette er en serie TeX Live-images som er spesielt optimalisert for Overleaf, og som også kan legges til i TEX_LIVE_DOCKER_IMAGE og ALL_TEX_LIVE_DOCKER_IMAGES:
  • ghcr.io/ayaka-notes/texlive-full:2026.1 (også taggen 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
Det finnes et strengt skjema for hvordan imagene må tagges (følgende regex gjelder: ^[0-9]+.[0-9]+, der det første tallet angir TeX Live-året og det andre patchversjonen).

Kan jeg bruke et annet image-register?

Noen lurer kanskje på om de kan erstatte ghcr.io med et annet speilnettsted, eller bytte texlive til et annet image fra Docker Hub?
Nei, vi anbefaler det ikke, fordi konfigurasjonen er relativt komplisert. Hvis du laster ned fra et speilnettsted, kan du gi imaget nytt navn til ghcr.io/ayaka-notes/texlive-full. Men hvis du virkelig vil bruke ditt eget image-register, legger du til:
config/variables.env
Deretter må du sørge for at alle texlive-imagene ligger i your-repo, for eksempel
  • hub.your.com/your-repo/texlive-full:2025.1
  • hub.your.com/your-repo/texlive-full:2024.1
For detaljert informasjon kan du lese kildekoden nedenfor for å forstå hvordan vi tolker miljøvariablene dine:
sandboxed-compiles/index.mjs

Automatisk synkronisering av TeX Live-images

For å slippe å oppdatere instansen manuelt med bin/up hver gang, kan du automatisere oppdateringer av TeX Live-imaget. Se updating-tex-live-full-images-automatically.md.

Kjente problemer

Dette er et reelt tilfelle fra Overleaf-fellesskapet:
Med 6.0.1-ext-v3.3 har jeg disse innstillingene i variables.env:
Dette fungerer fint med texlive/texlive:latest-full. Men jeg hentet et annet texlive-image, danteev/texlive:2025-10-15, og endret begge disse variablene til det nye imagenavnet, og da fungerer det ikke:
I loggene ser jeg følgende:
Det ser ut til at de oppdaterte innstillingene i variables.env ikke trer i kraft. Kompileringen prøver fortsatt å kjøre imaget texlive/texlive:latest-full, ikke det nye imaget. Jeg har prøvd å starte på nytt, slette containerne og kjøre igjen, men problemet er det samme. Noen løsninger?
På grunn av enkelte tekniske begrensninger gjelder følgende: hvis du bare setter opp ett enkelt Docker TeXLive-image, for eksempel texlive-fullA:latest
og etter å ha kjørt Overleaf-instansen en stund ønsker å endre TeXLive-imaget til texlive-fullB:latest, vil du se at brukerne dine ikke kan kompilere noen prosjekter.
Dette skyldes at navnet på TeXLive-Full-imaget (for sandkassekompilering) for hvert prosjekt lagres i databasen. Imagenavnet endres i databasen bare når brukeren bytter TeXLive-versjon for prosjektet sitt, for eksempel fra 2024 til 2025. Når CLSI kompilerer et prosjekt, bruker den containerimagenavnet som finnes i databasen, direkte til å kompilere prosjektet. Hvis du bare oppgir ett Docker-image, kan ikke brukerne endre imaget som brukes til å kompilere prosjektet. I så fall må du skrive et skript som manuelt endrer TeXLive-imaget for alle brukerprosjekter i MongoDB.

Feilsøking og rapportering

Kjør følgende kommando for å sjekke clsi-loggen fra Toolkit:
Hvis du støter på problemer med å kompilere med TeX Live-imagene, kan du opprette en issue her: https://github.com/ayaka-notes/texlive-full/issues/new?template=texlive-image-bug.yml For å hjelpe oss med å gjenskape og feilsøke problemet kan du bli bedt om å laste opp prosjektet ditt til Overleaf. Vi henter da prosjektet og kjører kompileringstester med GitHub Action.

Spørsmål og svar

Svar: Containerne og kompileringsfilene fjernes etter en viss tid; TeX Live-imagene gjør ikke det.
  • Kompileringscontainere (project-<project id>-<hash>) gjenbrukes på tvers av kompileringer av samme prosjekt, så de blir værende etter en kompilering. En kontroll kjører hver time og fjerner dem som er eldre enn én time, og der prosjektet ikke er kompilert den siste timen. En container er vanligvis borte én til to timer etter siste kompilering. Omstart av Overleaf fjerner dem ikke; det gjør neste timekontroll.
  • Containere for ordtelling, SyncTeX og konvertering fjernes så snart de er ferdige.
  • Kompileringsfiler (data/overleaf/data/compiles og output) fjernes når et prosjekt ikke har vært brukt på én dag, og dette kontrolleres hvert 10. minutt. Når det begynner å bli lite diskplass, forkortes denne perioden trinnvis, ned til en halv dag.
  • TeX Live-images fjernes aldri, siden hver kompilering trenger dem. For å frigjøre plass etter at du har fjernet et image fra ALL_TEX_LIVE_DOCKER_IMAGES, sletter du det med docker image rm <image>.
Det er ikke nødvendig å slette disse containerne manuelt.
Svar: Nei. Hver kompileringscontainer monterer bare kompileringsmappen til sitt eget prosjekt, på /compile, og har ikke nettverk, og det finnes ingen innstilling for å montere andre mapper fra verten i den. Last i stedet opp filene prosjektet trenger, til prosjektet.
Svar: Ja. ghcr.io/ayaka-notes/texlive-basic:<year>.1 (2020.1 til 2026.1) har TeX Live basic-skjemaet pluss noen få pakker som latexmk, xetex og fontspec, uten hele skriftsettet. Det er mye mindre enn texlive-full, men prosjekter som bruker andre pakker, får feil om manglende pakker. For TeX Live 2025 basic:
config/variables.env
ghcr.io/ayaka-notes/texlive-full:base er ikke et basic-image: det har ingen TeX Live og kan ikke kompilere.
Svar: Editoren viser det ikke, og clsi-loggen registrerer det bare på debug-nivå. Hver kompileringsforespørsel returnerer det imidlertid: åpne nettleserens utviklerverktøy, gå til fanen Network, kompiler på nytt, og velg forespørselen compile. JSON-svaret har timings i millisekunder, der compileE2E er hele kompileringen i kompileringstjenesten og compile er selve LaTeX-kjøringen.
Sist endret 13. november 2026