Forudsætninger
Overleaf er et typisk open source-projekt med mikroservicearkitektur, hvor alle tjenester kører i Docker.- Den officielle kildekode til Community Edition findes på GitHub Overleaf Official.
- Kildekoden til Overleaf-CEP er tilgængelig på GitHub Yu-i-i/Overleaf.
- Ayakaleaf Pro er tilgængelig på GitHub ayaka-notes/ayakaleaf-pro.
Da servere med 8 eller flere CPU-kerner typisk er dyre, anbefales det kraftigt at bruge din lokale computer til udvikling.
- En kraftig server/desktop til udvikling
- En nyere og stabil Ubuntu LTS (f.eks. Ubuntu 24.04)
- Et Docker- og Git-miljø
Konfigurationsvejledning
Her bruger vi Ayakaleaf Pro til at vise, hvordan du opsætter et udviklingsmiljø til Overleaf. Alle kommandoer nedenfor køres i mappendevelop, medmindre andet er angivet.
1
Hent kildekoden
Lad os først klone repositoriet:
bash
2
Synkroniser yarn.lock
Repoet bruger Yarn 4 (
packageManager i rodens package.json), og dets yarn.lock kan være ude af synk med package.json-filerne. Synkroniser den efter den første kloning og efter enhver ændring i en package.json:bash
bin/sync kører yarn install --mode=update-lockfile i en node:24.18.1-container, så du behøver ikke Node.js på værten. Commit ikke den ændrede yarn.lock.3
Byg udviklingsimaget
Byg tjenesterne:
bash
Hvis Docker løber tør for RAM, mens tjenesterne bygges parallelt, skal du oprette en
.env-fil i denne mappe, der indeholder COMPOSE_PARALLEL_LIMIT=1.4
Anvend oversættelserne
Modulerne i Ayakaleaf Pro har deres oversættelser i Det kræver
services/web/locales/locales_patches/, som de committede sprogfiler ikke indeholder. Anvend dem én gang før første start, ellers viser disse modulers sider nøgler som about_to_permanently_delete_accounts i stedet for tekst:bash
jq på værten. Kør det igen, når du har tilføjet en oversættelse eller skiftet gren, se Opdater i18n-oversættelser.5
Start alle mikrotjenester
Start derefter tjenesterne:Når tjenesterne kører, skal du åbne http://localhost/launchpad for at oprette den første administratorkonto. Tilføj porten, hvis du har ændret
bash
OVERLEAF_PORT (se nedenfor).LDAP er slået til som standard (
LDAP_ENABLED=true i dev.rc). Launchpad viser så LDAP-administratorformularen: den beder kun om en e-mailadresse, og den administrator logger derefter ind via LDAP, for eksempel som professor / professor (professor@planetexpress.com). Testbrugerne står i develop/authentication/README.md. Sæt LDAP_ENABLED=false og SAML_ENABLED=false for i stedet at oprette en lokal administrator med adgangskode.develop/dev.env sætter allerede ADMIN_PRIVILEGE_AVAILABLE=true, så administratorer kan åbne administrationspanelet uden ekstra opsætning.Konfiguration (dev.rc)
develop/dev.rc ved siden af dev.env indeholder udviklingsmiljøets kontakter, ligesom overleaf.rc i Overleaf Toolkit. Ændr en værdi, og kør bin/dev igen for at anvende den; en funktion, der er slået fra, stopper også sine containere.
Hver funktion har sin
docker-compose.yml og andre filer i sin egen mappe: authentication/ldap, authentication/saml, mail, s3, hoppscotch og grafana. En funktion, der har brug for en web-indstilling uden miljøvariabel, monterer en fil i /etc/overleaf/settings.d/, og develop/settings.dev-env.cjs fletter dem alle. Alle bin/*-scripts går gennem bin/docker-compose, som tilføjer filerne for de funktioner, der er slået til. Brug bin/docker-compose i stedet for docker compose, når du selv har brug for en compose-kommando.
Porte
Sitet, RustFS-konsollen og Hoppscotch lytter på værtens127.0.0.1; på en fjernmaskine skal du først videresende deres porte, for eksempel ssh -L 9001:localhost:9001 <host>. Sitet bruger OVERLEAF_PORT fra dev.rc, så tilføj porten til adresserne nedenfor, hvis du har ændret den.
Mailpit, Grafana, Mongo Express og RedisInsight serveres af sitet på deres egne stier via webpack-dev-server, så de behøver ingen egen port. Når du er logget ind, linker menuen Dev tools i sitets navigationslinje til dem; en side, hvis funktion er slået fra i
dev.rc, udelades. Opsætning af udviklingsværktøjer viser, hvad hver af dem gør.
S3-API’et (port 9000) og SMTP (port 1025) kan kun nås inde i Docker-netværket. Mongo (27017), Redis (6379), Mongo Express (8081), RedisInsight (5540) og git-bridge (8000) publiceres kun på værtens 127.0.0.1.
TeX Live
Sandkassekompileringer er slået til som standard:develop/dev.env sætter SANDBOXED_COMPILES=true og imagene ghcr.io/ayaka-notes/texlive-full:2026.1 og ghcr.io/ayaka-notes/texlive-full:2025.1. clsi henter ikke images selv, så hent dem én gang:
dev.env slår også Pandoc-konverteringer til med PANDOC_IMAGE=overleaf-pandoc:local. Byg det image én gang fra roden af repoet:
.env-fil i mappen develop med indholdet DOCKER_SOCKET_PATH=/var/run/docker.sock.raw
Udvikling
For at undgå at kørebin/build && bin/up efter hver kodeændring kan du køre Overleaf Community Edition i udviklingstilstand, hvor tjenesterne automatisk opdateres ved kodeændringer.
Det gør du med det medfølgende script bin/dev:
node --watch, som automatisk overvåger koden og genstarter tjenesterne efter behov. Kør det igen, når du har ændret dev.rc.
For at forbedre ydeevnen kan du starte kun en delmængde af tjenesterne i udviklingstilstand ved at give scriptet bin/dev en mellemrumsadskilt liste:
Hvis tjenesten
web startes i udviklingstilstand, opdateres web-tjenesten kun, når backend-koden ændres. For også at opdatere frontend-koden automatisk skal du sørge for også at starte tjenesten webpack i udviklingstilstand.bin/i18n, se Opdater i18n-oversættelser.
Fejlfinding
I udviklingstilstand eksponerer de fleste tjenester en fejlfindingsport, som du kan tilknytte en debugger til, for eksempel inspektøren i Chromes Dev Tools eller en, der er integreret i en IDE. Følgende tabel viser porten, der eksponeres på127.0.0.1 på værtsmaskinen for hver tjeneste:
For at tilknytte dig en tjeneste med Chromes remote debugging skal du gå til chrome://inspect/ og sikre dig, at Discover network targets er markeret. Klik derefter på Configure… og tilføj en post
localhost:[service port] for hver af de tjenester, du vil tilknytte en debugger til.
Når du har tilføjet en post, vises tjenesten som et Remote Target, som du kan inspicere og debugge.
Logning
Scriptetbin/logs følger logs og formaterer dem med bunyan. Det kræver også ggrep, som er navnet på GNU grep, når det installeres med Homebrew på macOS; Ubuntu har ingen ggrep-kommando.
bin/docker-compose i stedet for docker compose, så tjenesterne for funktionerne i dev.rc (mailpit, rustfs, ldap, saml, hoppscotch og grafana med Prometheus, Loki og eksportørerne) også findes.
Med GRAFANA_ENABLED=true ligger logs fra alle containere også i Grafana, hvor de kan filtreres efter tjeneste, niveau og tekst, se Opsætning af udviklingsværktøjer.

