> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/on-premises/pl/pierwsze-kroki/what-is-the-overleaf-toolkit.md). # Czym jest Overleaf Toolkit? Overleaf Toolkit to zalecana metoda wdrożenia dla instalacji lokalnych Community Edition, Server Pro lub Overleaf Pro; zaprojektowano go do pracy z najczęstszym środowiskiem: pojedynczym fizycznym serwerem lub maszyną wirtualną. Toolkit używa `docker compose` do zarządzania kontenerami Docker na serwerze i udostępnia zestaw skryptów, które opakowują `docker` polecenia, aby ułatwić bardziej techniczną stronę zarządzania lokalną wersją Overleaf. #### Skrypt `bin/docker-compose` opakowujący Skrypt `bin/docker-compose` jest opakowaniem wokół `docker compose`. Ładuje konfigurację z `config/` katalogu, przed wywołaniem `docker compose` z dowolnymi argumentami przekazanymi do skryptu. Możesz traktować `bin/docker-compose` jako przezroczysty wrapper dla programu `docker compose` zainstalowanego na twoim komputerze. Przykład: {% code title="Sprawdzenie działających kontenerów" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Pomocne skróty Oprócz `bin/docker-compose`, Toolkit udostępnia wygodne skrypty pomagające w typowych zadaniach: * `bin/up`: skrót do `bin/docker-compose up` * `bin/start`: skrót do `bin/docker-compose start` * `bin/stop`: skrót do `bin/docker-compose stop` * `bin/shell`: uruchamia powłokę wewnątrz **sharelatex** kontenera * `bin/doctor`: skrypt służący do zbierania informacji o instalacji i wdrożeniu. Zobacz sekcję „Sprawdzanie serwera” poniżej * `bin/mongo`: uruchamia powłokę wewnątrz **mongo** kontenera i przełącza się na właściwą bazę danych (**sharelatex**) * `bin/backup-config`: utwórz kopię (zip lub tar) bieżącej konfiguracji i zapisz ją w wybranym przez siebie katalogu docelowym * `bin/logs`: wyświetlaj/podglądaj logi usługi * `bin/error-logs`: wyświetlaj/podglądaj logi błędów usługi * `bin/rename-env-vars-5-0`: skrypt migracyjny do aktualizacji zmiennych środowiskowych w **config/variables.env** (rebranding z ShareLaTeX na Overleaf) * `bin/rename-rc-vars`: skrypt migracyjny do aktualizacji zmiennych środowiskowych w **config/overleaf.rc** (rebranding z ShareLaTeX na Overleaf) * `bin/run-script`: pomocnik upraszczający uruchamianie skryptów przechowywanych w **sharelatex** kontenera * `bin/upgrade`: pomaga przy aktualizacjach instancji. Skrypt sprawdzi dostępność aktualizacji Toolkit (przez git) i zaproponuje pobranie zmian, sprawdzi najnowszą wersję obrazu Docker i zaproponuje jej aktualizację. Zapewnia potwierdzanie krok po kroku, możliwość wykonania kopii zapasowej bieżącej konfiguracji oraz obsługuje zatrzymywanie/uruchamianie usług Docker. Więcej informacji: {% hint style="info" %} Jeśli wolisz uruchamiać instancję bez podłączania się do logów Dockera, możesz uruchomić `bin/up -d` aby uruchomić w trybie odłączonym. {% endhint %} #### Sprawdzanie serwera Overleaf Toolkit zawiera przydatny skrypt o nazwie `bin/doctor` który generuje raport wskazujący wszelkie niespełnione zależności. Przed kontynuowaniem uruchom `bin/doctor` skrypt i sprawdź, czy wszystko działa poprawnie: {% code title="Uruchom Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Przykładowy wynik (skrócony/poglądowy):
Przykładowy wynik z bin/doctor ``` ====== Overleaf Doctor ====== - Informacje o hoście - Linux - Wynik polecenia 'lsb_release -a': Nie są dostępne żadne moduły LSB. Identyfikator dystrybucji: Ubuntu Opis: Ubuntu 22.04.5 LTS Wydanie: 22.04 Nazwa kodowa: jammy - Zależności - bash - status: obecny - informacje o wersji: 5.1.16(1)-release - docker - status: obecny - informacje o wersji: Docker w wersji 27.3.1, kompilacja ce12230 - realpath - status: obecny - informacje o wersji: realpath (GNU coreutils) 8.32 - perl - status: obecny - informacje o wersji: 5.034000 - awk - status: obecny - informacje o wersji: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - status: obecny - informacje o wersji: OpenSSL 3.0.2 15 Mar 2022 (Biblioteka: OpenSSL 3.0.2 15 Mar 2022) - docker compose - status: obecny - informacje o wersji: Docker Compose w wersji v2.29.7 - Docker Daemon - status: uruchomiony ====== Konfiguracja ====== - config/version - status: obecny - wersja: 5.1.1 - config/overleaf.rc - status: obecny - wartości - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - zalogowano się do quay.io: true - SIBLING_CONTAINERS_ENABLED: true - OVERLEAF_LISTEN_IP: 0.0.0.0 - OVERLEAF_PORT: 80 - MONGO_ENABLED: true - MONGO_IMAGE: mongo - MONGO_VERSION: 6.0 - MONGO_DATA_PATH: data/mongo - REDIS_ENABLED: true - REDIS_IMAGE: redis:6.2 - REDIS_DATA_PATH: data/redis - config/variables.env - status: obecny - wartości - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Ostrzeżenia ====== - Brak, wszystko w porządku ====== Koniec ====== ```
Jeśli brakuje jakichś zależności, doctor wypisze ostrzeżenia. Jeśli napotkasz problemy, najpierw uruchom `bin/doctor` i sprawdź jego wynik pod kątem ostrzeżeń. {% hint style="info" %} * Użytkownicy darmowej Community Edition powinni otworzyć zgłoszenie na GitHubie: * Użytkownicy Server Pro powinni skontaktować się z pomocą techniczną: mailto: W obu przypadkach dołącz wynik `bin/doctor` w swojej wiadomości. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://overleaf-pro.ayaka.space/on-premises/pl/pierwsze-kroki/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.