Pliki i lokalizacje

Ta strona opisuje pliki konfiguracyjne używane przez Toolkit do konfigurowania Twojego wdrożenia Overleaf on-premises.

​

Dane trwałe

Overleaf Toolkit musi przechowywać dane trwałe, takie jak pliki potrzebne do kompilacji projektów LaTeX oraz zawartość bazy danych MongoDB. Odbywa się to przez zamontowanie kilku katalogów z maszyny hosta w kontenerach Docker i zapisywanie danych w tych katalogach.

​

Katalogi danych

Kontener sharelatex wymaga katalogu, w którym przechowuje dane związane z kompilacjami LaTeX. Ten katalog ustawia się za pomocą zmiennej OVERLEAF_DATA_PATH w pliku config/overleaf.rc.

Kontener mongo, jeśli jest włączony, wymaga katalogu do przechowywania plików bazy danych; to samo dotyczy kontenera redis. Te katalogi również można skonfigurować w config/overleaf.rc.

​

Uprawnienia plików

Ponieważ Docker działa jako root, właścicielem katalogów danych zostanie użytkownik root, nawet jeśli Toolkit jest używany przez użytkownika innego niż root. Nie stanowi to problemu, ale warto o tym pamiętać, jeśli zamierzasz modyfikować dane trwałe spoza kontenerów.

​

Lokalizacja plików konfiguracyjnych

Wszystkie pliki konfiguracyjne należące do użytkownika znajdują się w katalogu config/.

Ten katalog jest wykluczony z systemu kontroli wersji git, więc aktualizacja kodu Toolkit go nie zmieni. Toolkit nie zmieni żadnych danych w katalogu config/ bez Twojej zgody.

Zmiany w plikach konfiguracyjnych nie są automatycznie stosowane do istniejących kontenerów, nawet jeśli kontener zostanie zatrzymany i ponownie uruchomiony (za pomocą bin/stop i bin/start). Aby zastosować zmiany, uruchom bin/up — w tle docker compose automatycznie zastosuje zmiany konfiguracji w nowym kontenerze. (Możesz też uruchomić bin/up -d, jeśli nie chcesz podłączać się do logów Docker).

​

Plik overleaf.rc

Plik config/overleaf.rc zawiera najważniejsze ustawienia konfiguracyjne najwyższego poziomu używane przez Toolkit. Zawiera instrukcje ustawiające zmienne w formacie: VARIABLE_NAME=value

Szczegółowy opis wszystkich dostępnych opcji konfiguracyjnych znajdziesz w naszej sekcji ustawień.

​

Plik variables.env

Plik config/variables.env zawiera zmienne środowiskowe ładowane do kontenera sharelatex i używane do konfigurowania mikrousług Overleaf. Obejmują one nazwę aplikacji wyświetlaną w nagłówku interfejsu webowego, ustawienia wysyłania wiadomości e-mail oraz inne ustawienia premium, takie jak SSO do użytku z Server Pro.

Szczegółowy opis wszystkich dostępnych zmiennych środowiskowych znajdziesz w sekcji Zmienne środowiskowe.

​

Plik version

Plik config/version zawiera numer wersji obrazu Docker, który zostanie użyty do utworzenia działającej instancji Twojego serwera Overleaf.

Zmiany w tych plikach konfiguracyjnych nie są automatycznie stosowane do istniejących kontenerów, nawet jeśli kontener zostanie zatrzymany i ponownie uruchomiony (za pomocą bin/stop i bin/start). Aby zastosować zmiany, uruchom bin/up, a Toolkit automatycznie utworzy dla Ciebie nowy kontener z zastosowanymi zmianami konfiguracji.

​

Plik docker-compose.override.yml

Jeśli plik config/docker-compose.override.yml istnieje, zostanie dołączony do wywołania docker compose. Jest to przydatne do nadpisywania konfiguracji specyficznej dla Docker Compose.

Więcej szczegółów znajdziesz w dokumentacji docker-compose.