Hopp til hovedinnhold

Forutsetninger

Overleaf er et typisk åpen kildekode-prosjekt med mikrotjenestearkitektur, der alle tjenester kjører i Docker. For å sette opp et utviklingsmiljø for Overleaf trenger du en kraftig server; en konfigurasjon med minst 8 kjerner og 16 GB RAM anbefales, siden du må kjøre mer enn 20 containere samtidig.
Siden servere med 8 eller flere CPU-kjerner vanligvis er dyre, anbefales det sterkt å bruke din lokale datamaskin til utvikling.
Samtidig forventer vi at du som utvikler allerede er kjent med Docker-installasjon. Vi anbefaler sterkt å bruke en nyere og stabil Ubuntu LTS (f.eks. Ubuntu 24.04 i 2025–2026) og nyeste Docker til utvikling, da dette reduserer risikoen for uventede feil. Oppsummert trenger du:
  • En kraftig server/stasjonær maskin å utvikle på
  • En nyere og stabil Ubuntu LTS (f.eks. Ubuntu 24.04)
  • Docker- og Git-miljø

Konfigurasjonsveiledning

Her bruker vi Ayakaleaf Pro til å vise hvordan du setter opp et utviklingsmiljø for Overleaf. Alle kommandoene nedenfor kjøres i katalogen develop med mindre annet er oppgitt.
1

Hent kildekoden

Først kloner vi repositoriet:
bash
2

Synkroniser yarn.lock

Repoet bruker Yarn 4 (packageManager i rotens package.json), og yarn.lock kan være ute av synk med package.json-filene. Synkroniser den etter første kloning og etter enhver endring i en package.json:
bash
bin/sync kjører yarn install --mode=update-lockfile i en node:24.18.1-container, så du trenger ikke Node.js på verten. Ikke sjekk inn den endrede yarn.lock.
3

Bygg utviklingsimage

Bygg tjenestene:
bash
Hvis Docker går tom for RAM mens tjenestene bygges parallelt, oppretter du en .env-fil i denne katalogen som inneholder COMPOSE_PARALLEL_LIMIT=1.
4

Bruk oversettelsene

Modulene i Ayakaleaf Pro har oversettelsene sine i services/web/locales/locales_patches/, som de innsjekkede språkfilene ikke inneholder. Bruk dem én gang før første oppstart, ellers viser sidene til disse modulene nøkler som about_to_permanently_delete_accounts i stedet for tekst:
bash
Det trenger jq på verten. Kjør det igjen etter at du har lagt til en oversettelse eller byttet gren, se Oppdatere i18n-oversettelser.
5

Start alle mikrotjenester

Start deretter tjenestene:
bash
Når tjenestene kjører, åpner du http://localhost/launchpad for å opprette den første administratorkontoen. Legg til porten hvis du har endret OVERLEAF_PORT (se nedenfor).
LDAP er på som standard (LDAP_ENABLED=true i dev.rc). Launchpad viser da LDAP-administratorskjemaet: det ber bare om en e-postadresse, og den administratoren logger deretter inn via LDAP, for eksempel som professor / professor (professor@planetexpress.com). Testbrukerne er oppført i develop/authentication/README.md. Sett LDAP_ENABLED=false og SAML_ENABLED=false for i stedet å opprette en lokal administrator med passord.
develop/dev.env setter allerede ADMIN_PRIVILEGE_AVAILABLE=true, så administratorer kan åpne administrasjonspanelet uten ekstra oppsett.

Konfigurasjon (dev.rc)

develop/dev.rc, ved siden av dev.env, inneholder bryterne for utviklingsmiljøet, som overleaf.rc i Overleaf Toolkit. Endre en verdi og kjør bin/dev igjen for å ta den i bruk; en funksjon som er slått av, stopper også containerne sine. Hver funksjon har sin docker-compose.yml og andre filer i en egen mappe: authentication/ldap, authentication/saml, mail, s3, hoppscotch og grafana. En funksjon som trenger en web-innstilling uten miljøvariabel, monterer en fil i /etc/overleaf/settings.d/, og develop/settings.dev-env.cjs slår dem alle sammen. Alle bin/*-skriptene går via bin/docker-compose, som legger til filene for funksjonene som er slått på. Kall bin/docker-compose i stedet for docker compose når du selv trenger en compose-kommando.
De lokale volumene og RustFS er separate lagre: et prosjekt opprettet med S3_ENABLED=true har ingen historikk eller binære filer etter bytte til false, og omvendt. For å kopiere filene fra et miljø som kjørte før S3_ENABLED fantes, til RustFS, følg «Moving existing data into RustFS» i develop/README.md.

Porter

Nettstedet, RustFS-konsollen og Hoppscotch lytter på vertens 127.0.0.1; på en ekstern maskin videresender du først portene deres, for eksempel ssh -L 9001:localhost:9001 <host>. Nettstedet bruker OVERLEAF_PORT fra dev.rc, så legg til porten i adressene nedenfor hvis du har endret den. Mailpit, Grafana, Mongo Express og RedisInsight serveres av nettstedet på egne stier via webpack-dev-server, så de trenger ingen egen port. Når du er logget inn, lenker menyen Dev tools i nettstedets navigasjonslinje til dem; en side der funksjonen er slått av i dev.rc, utelates. Sett opp utviklingsverktøy viser hva hvert av dem gjør. S3-API-et (port 9000) og SMTP (port 1025) kan bare nås inne i Docker-nettverket. Mongo (27017), Redis (6379), Mongo Express (8081), RedisInsight (5540) og git-bridge (8000) publiseres bare på vertens 127.0.0.1.

TeX Live

Sandkassekompileringer er på som standard: develop/dev.env setter 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:
Se Sett opp Sandbox Compiles for detaljer.
Et prosjekt som ble opprettet mens SANDBOXED_COMPILES var slått av, har ikke noe TeX Live-image. Det kompileres fortsatt med standardimaget, men å hoppe mellom koden og PDF-en mislykkes med «That didn’t work. Recompile and try again.» Gi slike prosjekter imaget fra TEX_LIVE_DOCKER_IMAGE én gang; uten --commit viser skriptet bare hva det ville endret:
dev.env slår også på Pandoc-konverteringer med PANDOC_IMAGE=overleaf-pandoc:local. Bygg det imaget én gang, fra roten av repoet:
For å kompilere på en macOS-vert kan det hende du må overstyre stien til Docker-socketen ved å opprette en .env-fil i katalogen develop som inneholder DOCKER_SOCKET_PATH=/var/run/docker.sock.raw

Utvikling

For å slippe å kjøre bin/build && bin/up etter hver kodeendring kan du kjøre Overleaf Community Edition i utviklingsmodus, der tjenestene oppdateres automatisk ved kodeendringer. Bruk det medfølgende skriptet bin/dev til dette:
Dette starter alle tjenester med node --watch, som automatisk overvåker koden og starter tjenestene på nytt ved behov. Kjør det igjen etter at du har endret dev.rc. For bedre ytelse kan du starte bare et utvalg av tjenestene i utviklingsmodus ved å gi skriptet bin/dev en mellomromsseparert liste:
Hvis du starter web-tjenesten i utviklingsmodus, oppdateres web-tjenesten bare når backend-koden endres. For også å oppdatere frontend-koden automatisk må du sørge for å starte webpack-tjenesten i utviklingsmodus i tillegg.
Hvis ingen tjenester angis, starter alle tjenestene i utviklingsmodus. Etter at du har lagt til en oversettelse eller byttet gren, kjører du bin/i18n, se Oppdatere i18n-oversettelser.

Feilsøking

I utviklingsmodus eksponerer de fleste tjenester en feilsøkingsport som du kan koble en debugger til, for eksempel inspektøren i Chromes Dev Tools eller en som er integrert i en IDE. Tabellen nedenfor viser porten som eksponeres på 127.0.0.1 på vertsmaskinen for hver tjeneste: For å koble til en tjeneste med Chromes ekstern feilsøking går du til chrome://inspect/ og sørger for at Discover network targets er avkrysset. Klikk deretter Configure… og legg til en oppføring localhost:[service port] for hver tjeneste du vil koble en debugger til. Etter at du har lagt til en oppføring, vises tjenesten som et Remote Target som du kan inspisere og feilsøke.

Logging

Skriptet bin/logs følger loggene og formaterer dem med bunyan. Det trenger også ggrep, som er navnet på GNU grep når det installeres med Homebrew på macOS; Ubuntu har ingen ggrep-kommando.
Eller du kan kjøre direkte med:
Bruk bin/docker-compose i stedet for docker compose, slik at også tjenestene for funksjonene i dev.rc (mailpit, rustfs, ldap, saml, hoppscotch og grafana med Prometheus, Loki og eksportørene) blir funnet. Med GRAFANA_ENABLED=true ligger loggene fra hver container også i Grafana, der de kan filtreres etter tjeneste, nivå og tekst, se Sett opp utviklingsverktøy.

Andre verktøy

Når du er ferdig med alt dette, kan du se neste avsnitt for å legge til noen feilsøkingsverktøy i Overleaf-utviklingen din.
Sist endret 20. november 2026