Soubory a umístění

Tato stránka popisuje konfigurační soubory, které Toolkit používá ke konfiguraci vašeho on-premises nasazení Overleaf.

​

Trvalá data

Overleaf Toolkit potřebuje ukládat trvalá data, například soubory potřebné ke kompilaci projektů v LaTeXu a obsah databáze MongoDB. Toho se dosahuje připojením několika adresářů z hostitelského stroje do kontejnerů Dockeru a zápisem dat do těchto adresářů.

​

Datové adresáře

Kontejner sharelatex vyžaduje adresář, do kterého ukládá data související s kompilacemi LaTeXu. Tento adresář se nastavuje proměnnou OVERLEAF_DATA_PATH v souboru config/overleaf.rc.

Kontejner mongo, pokud je povolen, vyžaduje adresář pro ukládání svých databázových souborů, a totéž platí pro kontejner redis. Tyto adresáře lze rovněž nakonfigurovat v config/overleaf.rc.

​

Oprávnění k souborům

Protože Docker běží jako root, budou datové adresáře nakonec vlastněny uživatelem root, i když Toolkit používá uživatel bez rootovských práv. Nejde o problém, ale je dobré o tom vědět, pokud hodláte trvalá data měnit mimo kontejnery.

​

Umístění konfiguračních souborů

Všechny konfigurační soubory vlastněné uživatelem se nacházejí v adresáři config/.

Tento adresář je vyloučen ze systému správy verzí git, takže se při aktualizaci kódu Toolkitu nezmění. Toolkit nezmění žádná data v adresáři config/ bez vašeho svolení.

Změny konfiguračních souborů se na existující kontejnery automaticky nepoužijí, a to ani tehdy, když kontejner zastavíte a znovu spustíte (pomocí bin/stop a bin/start). Chcete-li změny použít, spusťte bin/up a docker compose na pozadí automaticky použije konfigurační změny na nový kontejner. (Nebo spusťte bin/up -d, pokud se nechcete připojit k logům Dockeru.)

​

Soubor overleaf.rc

Soubor config/overleaf.rc obsahuje nejdůležitější konfigurační nastavení nejvyšší úrovně, která Toolkit používá. Obsahuje příkazy nastavující proměnné ve formátu: VARIABLE_NAME=value

Přehled všech dostupných možností konfigurace najdete v naší sekci nastavení.

​

Soubor variables.env

Soubor config/variables.env obsahuje proměnné prostředí, které se načítají do kontejneru sharelatex a slouží ke konfiguraci mikroslužeb Overleaf. Patří mezi ně název aplikace zobrazovaný v záhlaví webového rozhraní, nastavení pro odesílání e-mailů a další prémiová nastavení, například SSO pro použití se Server Pro.

Přehled všech dostupných proměnných prostředí najdete v sekci Proměnné prostředí.

​

Soubor version

Soubor config/version obsahuje číslo verze Docker image, který bude použit k vytvoření běžící instance vašeho serveru Overleaf.

Změny těchto konfiguračních souborů se na existující kontejnery automaticky nepoužijí, a to ani tehdy, když kontejner zastavíte a znovu spustíte (pomocí bin/stop a bin/start). Chcete-li změny použít, spusťte bin/up a Toolkit vám automaticky vytvoří nový kontejner s použitými konfiguračními změnami.

​

Soubor docker-compose.override.yml

Pokud existuje, bude soubor config/docker-compose.override.yml zahrnut do volání docker compose. To je užitečné pro přepsání konfigurace specifické pro Docker Compose.

Další podrobnosti najdete v dokumentaci docker-compose.