Přejít na hlavní obsah

Předpoklady

Overleaf je typický open-source projekt s mikroservisní architekturou, ve kterém všechny služby běží v Dockeru. K nastavení vývojového prostředí Overleafu budete potřebovat výkonný server; doporučujeme konfiguraci alespoň s 8 jádry a 16 GB RAM, protože bude potřeba současně provozovat více než 20 kontejnerů.
Protože servery s 8 a více jádry CPU bývají obvykle drahé, důrazně doporučujeme vyvíjet na vlastním lokálním počítači.
Zároveň předpokládáme, že jako vývojář už znáte instalaci Dockeru. Důrazně doporučujeme pro vývoj používat aktuální a stabilní Ubuntu LTS (např. Ubuntu 24.04 v letech 2025–2026) a nejnovější Docker, protože se tím snižuje pravděpodobnost neočekávaných chyb. Shrnuto, budete potřebovat:
  • Výkonný server/desktop pro vývoj
  • Aktuální a stabilní Ubuntu LTS (např. Ubuntu 24.04)
  • Prostředí Docker a Git

Návod ke konfiguraci

Zde na Ayakaleaf Pro ukazujeme, jak nastavit vývojové prostředí Overleaf. Všechny níže uvedené příkazy se spouštějí v adresáři develop, pokud není uvedeno jinak.
1

Stažení zdrojového kódu

Nejprve si naklonujte repozitář:
bash
2

Synchronizace yarn.lock

Repozitář používá Yarn 4 (packageManager v kořenovém package.json) a jeho yarn.lock nemusí být synchronizovaný se soubory package.json. Synchronizujte jej po prvním klonování a po každé změně v package.json:
bash
bin/sync spouští yarn install --mode=update-lockfile v kontejneru node:24.18.1, takže na hostiteli nepotřebujete Node.js. Změněný yarn.lock necommitujte.
3

Sestavení vývojového image

Sestavte služby:
bash
Pokud Dockeru při paralelním sestavování služeb dochází RAM, vytvořte v tomto adresáři soubor .env obsahující COMPOSE_PARALLEL_LIMIT=1.
4

Použití překladů

Moduly Ayakaleaf Pro mají své překlady v services/web/locales/locales_patches/, které commitnuté soubory lokalizací neobsahují. Použijte je jednou před prvním spuštěním, jinak stránky těchto modulů zobrazí místo textu klíče jako about_to_permanently_delete_accounts:
bash
Na hostiteli vyžaduje jq. Spusťte jej znovu po přidání překladu nebo změně větve, viz Aktualizace překladů i18n.
5

Spuštění všech mikroslužeb

Poté spusťte služby:
bash
Jakmile služby běží, otevřete http://localhost/launchpad a vytvořte první administrátorský účet. Pokud jste změnili OVERLEAF_PORT, přidejte port (viz níže).
LDAP je ve výchozím stavu zapnutý (LDAP_ENABLED=true v dev.rc). Launchpad pak zobrazí formulář administrátora LDAP: žádá jen e-mail a tento administrátor se poté přihlašuje přes LDAP, například jako professor / professor (professor@planetexpress.com). Testovací uživatelé jsou uvedeni v develop/authentication/README.md. Nastavte LDAP_ENABLED=false a SAML_ENABLED=false, chcete-li místo toho vytvořit lokálního administrátora s heslem.
develop/dev.env už nastavuje ADMIN_PRIVILEGE_AVAILABLE=true, takže administrátoři mohou otevřít administrační panel bez dalšího nastavení.

Konfigurace (dev.rc)

develop/dev.rc vedle dev.env obsahuje přepínače vývojového prostředí, podobně jako overleaf.rc v Overleaf Toolkit. Změňte hodnotu a znovu spusťte bin/dev, aby se projevila; vypnutá funkce také zastaví své kontejnery. Každá funkce má svůj docker-compose.yml a další soubory ve vlastní složce: authentication/ldap, authentication/saml, mail, s3, hoppscotch a grafana. Funkce, která potřebuje nastavení web bez proměnné prostředí, připojí soubor do /etc/overleaf/settings.d/ a develop/settings.dev-env.cjs je všechny sloučí. Všechny skripty bin/* procházejí přes bin/docker-compose, který přidá soubory zapnutých funkcí. Když sami potřebujete příkaz compose, volejte bin/docker-compose místo docker compose.
Lokální svazky a RustFS jsou oddělená úložiště: projekt vytvořený s S3_ENABLED=true nemá po přepnutí na false historii ani binární soubory, a naopak. Chcete-li do RustFS zkopírovat soubory prostředí, které běželo dříve, než S3_ENABLED existovalo, postupujte podle „Moving existing data into RustFS“ v develop/README.md.

Porty

Web, konzole RustFS a Hoppscotch naslouchají na 127.0.0.1 hostitele; na vzdáleném počítači nejprve přesměrujte jejich porty, například ssh -L 9001:localhost:9001 <host>. Web používá OVERLEAF_PORT z dev.rc, takže pokud jste jej změnili, přidejte port k níže uvedeným adresám. Mailpit, Grafanu, Mongo Express a RedisInsight poskytuje web na vlastních cestách přes webpack-dev-server, takže nepotřebují vlastní port. Po přihlášení na ně odkazuje menu Dev tools v navigační liště webu; stránka, jejíž funkce je v dev.rc vypnutá, se vynechá. Nastavení vývojových nástrojů ukazuje, co každý z nich dělá. API S3 (port 9000) a SMTP (port 1025) jsou dostupné jen uvnitř sítě Dockeru. Mongo (27017), Redis (6379), Mongo Express (8081), RedisInsight (5540) a git-bridge (8000) jsou publikovány jen na 127.0.0.1 hostitele.

TeX Live

Kompilace v sandboxu jsou ve výchozím stavu zapnuté: develop/dev.env nastavuje SANDBOXED_COMPILES=true a image ghcr.io/ayaka-notes/texlive-full:2026.1 a ghcr.io/ayaka-notes/texlive-full:2025.1. clsi sám image nestahuje, proto je jednou stáhněte:
Podrobnosti najdete v Nastavení kompilací v sandboxu.
Projekt vytvořený v době, kdy bylo SANDBOXED_COMPILES vypnuté, nemá image TeX Live. Stále se kompiluje s výchozím image, ale přechod mezi kódem a PDF selže s hláškou „That didn’t work. Recompile and try again.“ Přiřaďte takovým projektům jednou image z TEX_LIVE_DOCKER_IMAGE; bez --commit skript jen ukáže, co by změnil:
dev.env také zapíná převody Pandoc s PANDOC_IMAGE=overleaf-pandoc:local. Sestavte tento image jednou z kořene repozitáře:
Chcete-li kompilovat na hostiteli s macOS, možná budete muset přepsat cestu k socketu Dockeru vytvořením souboru .env v adresáři develop s obsahem DOCKER_SOCKET_PATH=/var/run/docker.sock.raw

Vývoj

Abyste nemuseli po každé změně kódu spouštět bin/build && bin/up, můžete Overleaf Community Edition spustit ve vývojovém režimu, ve kterém se služby při změnách kódu automaticky aktualizují. K tomu použijte přiložený skript bin/dev:
Tím se všechny služby spustí pomocí node --watch, který automaticky sleduje kód a podle potřeby služby restartuje. Po změně dev.rc jej spusťte znovu. Pro zlepšení výkonu můžete ve vývojovém režimu spustit jen část služeb tak, že skriptu bin/dev předáte jejich seznam oddělený mezerami:
Spuštění služby web ve vývojovém režimu aktualizuje službu web pouze při změnách backendového kódu. Aby se automaticky aktualizoval i frontendový kód, nezapomeňte ve vývojovém režimu spustit také službu webpack.
Pokud nejsou uvedeny žádné služby, spustí se ve vývojovém režimu všechny. Po přidání překladu nebo změně větve spusťte bin/i18n, viz Aktualizace překladů i18n.

Ladění

Ve vývojovém režimu většina služeb zpřístupňuje ladicí port, ke kterému můžete připojit debugger, například inspektor v Chrome Dev Tools nebo debugger integrovaný v IDE. Následující tabulka ukazuje port zpřístupněný na 127.0.0.1 hostitelského počítače pro každou službu: Chcete-li se ke službě připojit pomocí vzdáleného ladění v Chromu, přejděte na chrome://inspect/ a ujistěte se, že je zaškrtnuto Discover network targets. Poté klikněte na Configure… a přidejte položku localhost:[service port] pro každou ze služeb, ke které chcete připojit debugger. Po přidání položky se služba zobrazí jako Remote Target, který můžete zkoumat a ladit.

Logování

Skript bin/logs sleduje logy a formátuje je pomocí bunyan. Potřebuje také ggrep, což je název GNU grep při instalaci přes Homebrew v macOS; Ubuntu příkaz ggrep nemá.
Případně můžete přímo spustit:
Používejte bin/docker-compose místo docker compose, aby se našly i služby funkcí z dev.rc (mailpit, rustfs, ldap, saml, hoppscotch a grafana s Prometheem, Loki a exportéry). S GRAFANA_ENABLED=true jsou logy každého kontejneru také v Grafaně, kde je lze filtrovat podle služby, úrovně a textu, viz Nastavení vývojových nástrojů.

Další nástroje

Až budete mít vše hotové, můžete pokračovat další částí a přidat do svého vývoje Overleafu některé ladicí nástroje.
Naposledy změněno 20. listopadu 2026