Förutsättningar
Overleaf är ett typiskt open source-projekt med mikrotjänstarkitektur, där alla tjänster körs i Docker.- Källkoden för den officiella Community Edition finns på GitHub Overleaf Official.
- Källkoden för Overleaf-CEP finns på GitHub Yu-i-i/Overleaf.
- Ayakaleaf Pro finns på GitHub ayaka-notes/ayakaleaf-pro.
Eftersom servrar med 8 eller fler CPU-kärnor vanligtvis är dyra rekommenderar vi starkt att du använder din lokala dator för utveckling.
- En kraftfull server/dator att utveckla på
- En aktuell och stabil Ubuntu LTS (t.ex. Ubuntu 24.04)
- En miljö med Docker och Git
Konfigurationsguide
Här använder vi Ayakaleaf Pro för att visa hur du sätter upp en utvecklingsmiljö för Overleaf. Alla kommandon nedan körs i katalogendevelop om inget annat anges.
1
Hämta källkoden
Först klonar vi repot:
bash
2
Synkronisera yarn.lock
Repot använder Yarn 4 (
packageManager i rotens package.json), och dess yarn.lock kan vara osynkroniserad med package.json-filerna. Synkronisera den efter den första kloningen och efter varje ändring i en package.json:bash
bin/sync kör yarn install --mode=update-lockfile i en node:24.18.1-container, så du behöver inte Node.js på värden. Checka inte in den ändrade yarn.lock.3
Bygg utvecklingsavbildningen
Bygg tjänsterna:
bash
Om Docker får slut på RAM när tjänsterna byggs parallellt skapar du en
.env-fil i den här katalogen som innehåller COMPOSE_PARALLEL_LIMIT=1.4
Tillämpa översättningarna
Modulerna i Ayakaleaf Pro har sina översättningar i Det kräver
services/web/locales/locales_patches/, som de incheckade språkfilerna inte innehåller. Tillämpa dem en gång före första starten, annars visar modulernas sidor nycklar som about_to_permanently_delete_accounts i stället för text:bash
jq på värden. Kör det igen efter att du har lagt till en översättning eller bytt gren, se Uppdatera i18n-översättningar.5
Starta alla mikrotjänster
Starta sedan tjänsterna:När tjänsterna körs öppnar du http://localhost/launchpad för att skapa det första administratörskontot. Lägg till porten om du har ändrat
bash
OVERLEAF_PORT (se nedan).LDAP är på som standard (
LDAP_ENABLED=true i dev.rc). Launchpad visar då LDAP-administratörsformuläret: det frågar bara efter en e-postadress, och den administratören loggar sedan in via LDAP, till exempel som professor / professor (professor@planetexpress.com). Testanvändarna listas i develop/authentication/README.md. Sätt LDAP_ENABLED=false och SAML_ENABLED=false för att i stället skapa en lokal administratör med lösenord.develop/dev.env sätter redan ADMIN_PRIVILEGE_AVAILABLE=true, så administratörer kan öppna administrationspanelen utan extra konfiguration.Konfiguration (dev.rc)
develop/dev.rc, bredvid dev.env, innehåller utvecklingsmiljöns reglage, som overleaf.rc i Overleaf Toolkit. Ändra ett värde och kör bin/dev igen för att tillämpa det; en avstängd funktion stoppar även sina containrar.
Varje funktion har sin
docker-compose.yml och övriga filer i en egen mapp: authentication/ldap, authentication/saml, mail, s3, hoppscotch och grafana. En funktion som behöver en web-inställning utan miljövariabel monterar en fil i /etc/overleaf/settings.d/, och develop/settings.dev-env.cjs slår ihop dem alla. Alla bin/*-skript går via bin/docker-compose, som lägger till filerna för de påslagna funktionerna. Anropa bin/docker-compose i stället för docker compose när du själv behöver ett compose-kommando.
Portar
Webbplatsen, RustFS-konsolen och Hoppscotch lyssnar på värdens127.0.0.1; på en fjärrdator vidarebefordrar du först deras portar, till exempel ssh -L 9001:localhost:9001 <host>. Webbplatsen använder OVERLEAF_PORT från dev.rc, så lägg till porten i adresserna nedan om du har ändrat den.
Mailpit, Grafana, Mongo Express och RedisInsight serveras av webbplatsen på egna sökvägar via webpack-dev-server, så de behöver ingen egen port. När du är inloggad länkar menyn Dev tools i webbplatsens navigeringsfält till dem; en sida vars funktion är avstängd i
dev.rc utelämnas. Konfigurera utvecklingsverktyg visar vad var och en gör.
S3-API:t (port 9000) och SMTP (port 1025) går bara att nå inuti Docker-nätverket. Mongo (27017), Redis (6379), Mongo Express (8081), RedisInsight (5540) och git-bridge (8000) publiceras bara på värdens 127.0.0.1.
TeX Live
Sandlådekompileringar är på som standard:develop/dev.env sätter SANDBOXED_COMPILES=true och avbildningarna ghcr.io/ayaka-notes/texlive-full:2026.1 och ghcr.io/ayaka-notes/texlive-full:2025.1. clsi hämtar inte avbildningar själv, så hämta dem en gång:
dev.env slår även på Pandoc-konverteringar med PANDOC_IMAGE=overleaf-pandoc:local. Bygg den avbildningen en gång, från repots rot:
.env-fil i katalogen develop som innehåller DOCKER_SOCKET_PATH=/var/run/docker.sock.raw
Utveckling
För att slippa körabin/build && bin/up efter varje kodändring kan du köra Overleaf Community Edition i utvecklingsläge, där tjänsterna uppdateras automatiskt vid kodändringar.
Använd det medföljande skriptet bin/dev för detta:
node --watch, som automatiskt övervakar koden och startar om tjänsterna vid behov. Kör det igen efter att du har ändrat dev.rc.
För bättre prestanda kan du starta endast en delmängd av tjänsterna i utvecklingsläge genom att ange en blankstegsseparerad lista till skriptet bin/dev:
Om tjänsten
web startas i utvecklingsläge uppdateras tjänsten web endast när backendkoden ändras. För att även frontendkoden ska uppdateras automatiskt ser du till att också starta tjänsten webpack i utvecklingsläge.bin/i18n efter att du har lagt till en översättning eller bytt gren, se Uppdatera i18n-översättningar.
Felsökning
I utvecklingsläge exponerar de flesta tjänster en felsökningsport som du kan koppla en debugger till, till exempel inspektören i Chromes Dev Tools eller en som är integrerad i en IDE. Följande tabell visar porten som exponeras på127.0.0.1 på värddatorn för varje tjänst:
För att ansluta till en tjänst med Chromes fjärrfelsökning går du till chrome://inspect/ och ser till att Discover network targets är markerat. Klicka sedan på Configure… och lägg till en post
localhost:[service port] för var och en av de tjänster du vill ansluta en debugger till.
När du har lagt till en post visas tjänsten som ett Remote Target som du kan inspektera och felsöka.
Loggning
Skriptetbin/logs följer loggarna och formaterar dem med bunyan. Det behöver även ggrep, vilket är namnet på GNU grep när det installeras med Homebrew på macOS; Ubuntu har inget ggrep-kommando.
bin/docker-compose i stället för docker compose, så att även tjänsterna för funktionerna i dev.rc (mailpit, rustfs, ldap, saml, hoppscotch och grafana med Prometheus, Loki och exportörerna) hittas.
Med GRAFANA_ENABLED=true finns loggarna från varje container också i Grafana, där de kan filtreras efter tjänst, nivå och text, se Konfigurera utvecklingsverktyg.

