2. Poznaj Toolkit

​

Rozejrzyjmy się

Masz już lokalną kopię Toolkitu, więc przyjrzyjmy się strukturze repozytorium za pomocą polecenia ls.

Run this

ls -l

Polecenie ls -l wyświetla szczegółową, długą listę zawartości katalogu, zawierającą dodatkowe informacje o plikach, takie jak uprawnienia, właściciel i rozmiar.

Jeśli klonowanie przebiegło pomyślnie, powinieneś zobaczyć coś takiego:

drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md

Wszystkie pliki konfiguracyjne należące do użytkownika znajdują się w katalogu config/. Ten katalog jest wyłączony z systemu kontroli wersji git, więc aktualizacja Toolkitu go nie zmieni.

​

Struktura repozytorium

Nazwa	Opis
bin	Ten folder zawiera zestaw skryptów pomagających zarządzać instancją serwera Overleaf. Więcej o tych skryptach przeczytasz w sekcji Polecenia poniżej.
config	Ten folder zawiera Twoje lokalne pliki konfiguracyjne.
lib	Ten folder zawiera bazowe pliki konfiguracyjne używane przez Toolkit.
data	Domyślnie ten folder zawiera lokalizację przechowywania danych MongoDb, Redis i Overleaf. Więcej informacji znajdziesz w sekcji Dane trwałe poniżej.

Zalecamy, aby nie modyfikować bezpośrednio plików poza folderem /config. Jeśli musisz wprowadzić zmiany, możesz to zrobić za pomocą zmiennych środowiskowych ustawianych w pliku config/variables.env lub config/overleaf.rc.
Na przykład, aby ustawić obraz usługi mongo, zamiast bezpośrednio edytować lib/docker-compose.mongo.yml, ustaw obraz za pomocą zmiennej środowiskowej MONGO_IMAGE w pliku config/overleaf.rc. Więcej informacji znajdziesz na stronie Ustawienia Toolkitu.

Toolkit nie zmieni żadnych danych w katalogu config/ bez Twojej zgody.

​

Polecenia

Uruchamiaj te skrypty z katalogu Toolkit. Każdy z nich wyświetla swoje opcje po podaniu --help.

Polecenie	Działanie
bin/init	Tworzy pliki konfiguracyjne w config/ przy pierwszym uruchomieniu. bin/init --tls dodaje konfigurację proxy TLS NGINX.
bin/up	Tworzy i uruchamia kontenery (bin/docker-compose up). Dodaj -d, aby działały w tle zamiast śledzenia logów. Uruchamiaj je po każdej zmianie w config/: odtwarza kontenery, których konfiguracja się zmieniła.
bin/start	Ponownie uruchamia istniejące kontenery (bin/docker-compose start). Nie stosuje zmian konfiguracji.
bin/stop	Zatrzymuje kontenery, ale ich nie usuwa (bin/docker-compose stop).
bin/docker-compose	Uruchamia docker compose z plikami Toolkit, na przykład bin/docker-compose ps lub bin/docker-compose restart sharelatex.
bin/logs	Wyświetla lub śledzi logi jednej lub kilku usług, na przykład bin/logs -f web.
bin/error-logs	Działa jak bin/logs, ale wyświetla tylko błędy.
bin/shell	Otwiera powłokę wewnątrz kontenera sharelatex.
bin/mongo	Otwiera powłokę MongoDB dla bazy danych sharelatex.
bin/run-script	Uruchamia skrypt dostarczany wewnątrz kontenera sharelatex.
bin/doctor	Sprawdza hosta i konfigurację oraz wyświetla raport, który możesz udostępnić, prosząc o pomoc.
bin/images	Wyświetla listę obrazów Docker Overleaf na hoście.
bin/backup-config	Kopiuje katalog config/ do lokalizacji kopii zapasowej (kopia, zip lub tar).
bin/upgrade	Aktualizuje Toolkit i obraz Overleaf krok po kroku, zobacz Aktualizacja wdrożenia.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Jednorazowe migracje starych nazw zmiennych SHARELATEX_* na OVERLEAF_*.

Gdy bin/up odtwarza kontener, wszystkie zmiany wprowadzone w jego wnętrzu zostają utracone, na przykład pakiety zainstalowane lub pliki edytowane za pomocą bin/shell. Zachowywane są tylko katalogi danych (domyślnie data/) oraz config/. Trwałe zmiany wprowadzaj zamiast tego za pomocą config/variables.env, config/overleaf.rc lub config/docker-compose.override.yml.

Jeśli każde bin/up wylogowuje wszystkich użytkowników, ustaw OVERLEAF_SESSION_SECRET. Bez tej zmiennej ciasteczka sesji są podpisywane sekretem generowanym od nowa przy każdym odtworzeniu kontenera, zobacz sekcję Pytania i odpowiedzi w Zmienne środowiskowe.