5. Personalizacja instancji

​

Personalizacja instancji

Przed pierwszym uruchomieniem instancji Overleaf zaktualizuj dwa pliki konfiguracyjne, wprowadzając własne dane:

Plik	Odczytywany przez	Co się w nim ustawia
config/overleaf.rc	skrypty Toolkit, takie jak bin/up	sposób działania kontenerów: OVERLEAF_LISTEN_IP, OVERLEAF_PORT, SERVER_PRO, ścieżki danych
config/variables.env	aplikację wewnątrz kontenera	zachowanie Overleaf: OVERLEAF_SITE_URL, e-mail, obrazy TeX Live

1. Edytuj plik zmiennych

   Otwórz config/variables.env w ulubionym edytorze tekstu i zaktualizuj poniższe zmienne środowiskowe, podając wymagane wartości.

2. Adres i port nasłuchiwania

   Domyślnie Toolkit publikuje interfejs webowy pod adresem 127.0.0.1:80, więc można go otworzyć wyłącznie w przeglądarce na samym serwerze. Inne komputery otrzymują błąd “connection refused” lub “server not found”. Aby to zmienić, edytuj config/overleaf.rc:

   config/overleaf.rc

   OVERLEAF_LISTEN_IP=0.0.0.0
   OVERLEAF_PORT=8080
   

   OVERLEAF_LISTEN_IP to adres IP hosta, z którym wiąże się kontener, a OVERLEAF_PORT to port hosta. Razem tworzą mapowanie portów Docker OVERLEAF_LISTEN_IP:OVERLEAF_PORT:80. Wybierz wartości odpowiadające Twojej konfiguracji:

   Konfiguracja	OVERLEAF_LISTEN_IP	OVERLEAF_PORT	Adres w przeglądarce
   Tylko na tej maszynie (domyślnie)	127.0.0.1	80	http://localhost
   Inne komputery w sieci LAN lub z internetu łączą się bezpośrednio	0.0.0.0 lub jeden z adresów IP serwera	80 lub dowolny wolny port	http://<server-ip>:<port>
   Za własnym reverse proxy (NGINX, Caddy, Cloudflare Tunnel) na tym samym hoście	127.0.0.1	dowolny wolny port	adres URL proxy
   Za proxy TLS z Toolkit	127.0.0.1	80	https://<your-domain>

   Jeśli port 80 jest już zajęty na hoście, na przykład przez inny serwer WWW, ustaw OVERLEAF_PORT na wolny port, np. 8080. W przeciwnym razie bin/up zakończy się błędem bind: address already in use.

   Porty publikowane przez Docker omijają zapory hosta, takie jak ufw i firewalld. Przy 0.0.0.0 instancja jest dostępna z każdej sieci, do której podłączony jest serwer. Na serwerze w chmurze musisz również zezwolić na ruch na tym porcie w grupie zabezpieczeń dostawcy. Zanim udostępnisz instancję w internecie, skonfiguruj HTTPS, zobacz Proxy TLS.

   Możesz zacząć od wartości domyślnych i najpierw otworzyć instancję pod adresem localhost. Aby później umożliwić dostęp z innych komputerów, zmień te dwie zmienne w config/overleaf.rc oraz OVERLEAF_SITE_URL w config/variables.env, a następnie ponownie uruchom bin/up, aby odtworzyć kontenery.

3. Wymagane zmienne środowiskowe

   Zaktualizuj następujące zmienne w config/variables.env:

   Nazwa	Opis	Przykład
   OVERLEAF_SITE_URL	Adres, pod którym Twoja instancja Overleaf jest publicznie dostępna. Jest używany w linkach publicznych oraz przy połączeniach przez websockety, więc musi być poprawnie skonfigurowany!	https://overleaf.lilliput.com
   OVERLEAF_EMAIL_FROM_ADDRESS	Ten adres e-mail będzie używany jako adres from (nadawca) we wszystkich wychodzących wiadomościach e-mail.	[e-mail]
   OVERLEAF_ADMIN_EMAIL	Adres e-mail, pod którym użytkownicy mogą skontaktować się z osobą zarządzającą witryną.	[e-mail]

   OVERLEAF_SITE_URL to adres, który użytkownicy wpisują w przeglądarce, a nie adres nasłuchiwania. Podaj port, jeśli jest inny niż 80 (HTTP) lub 443 (HTTPS), na przykład http://192.168.1.20:8080. Nie używaj http://0.0.0.0. Jeśli OVERLEAF_SITE_URL nie odpowiada adresowi w przeglądarce, edytor nie może nawiązać połączenia, a linki w wiadomościach e-mail i wywołania zwrotne OAuth prowadzą w niewłaściwe miejsce.

   Bez serwera poczty pozostaw OVERLEAF_EMAIL_FROM_ADDRESS nieustawione: Overleaf nie wysyła wtedy żadnych wiadomości e-mail, a link aktywacyjny możesz przekazać nowym użytkownikom samodzielnie, zobacz sekcję Pytania i odpowiedzi w Dostęp publiczny.

   Ustaw także OVERLEAF_SESSION_SECRET na wartość wygenerowaną poleceniem openssl rand -hex 32. Bez tego każde bin/up, które odtwarza kontener, oraz każda aktualizacja wylogowuje wszystkich użytkowników. Zobacz sekcję Pytania i odpowiedzi w Zmienne środowiskowe.

   Po zaktualizowaniu tych zmiennych środowiskowych zapisz plik i zamknij edytor.

4. Skonfiguruj Sandbox Compile

   Następnie skonfiguruj TeX Live Full dla sandboxed-compiles.md. Otwórz config/variables.env i zaktualizuj następujące zmienne środowiskowe:

   config/variables.env

   ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1
   ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025
   TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
   
5. Uruchom instancję

   Aby uruchomić instancję, wykonaj:

   Start the instance

   bin/up
   

   To polecenie pobierze wymagane obrazy, w tym texlive, utworzy kontenery (z uwzględnieniem Twoich ustawień) i uruchomi instancję. Powinieneś zobaczyć logi z poszczególnych kontenerów Dockera.

   Aby później ponownie uruchomić kontenery (bez podłączania się do logów), wykonaj:

   Start without attaching to logs

   bin/start
   

Toolkit używa docker compose do zarządzania kontenerami Dockera Overleaf. Toolkit udostępnia zestaw skryptów, które opakowują docker compose i zajmują się większością szczegółów za Ciebie.

Jeśli wszystko pójdzie dobrze, powinieneś zobaczyć stronę logowania nowej instancji Overleaf, przechodząc w przeglądarce pod adres http://127.0.0.1/ lub http://localhost/. Jeśli zmieniono OVERLEAF_LISTEN_IP lub OVERLEAF_PORT, otwórz zamiast tego adres z tabeli w kroku Adres i port nasłuchiwania, na przykład http://<server-ip>:8080.

Aby sprawdzić, pod jakim adresem i portem opublikowany jest interfejs webowy, uruchom:

Show the published port

bin/docker-compose port sharelatex 80

Wynik, na przykład 0.0.0.0:8080, pokazuje używany adres IP hosta i port. Jeśli wyświetla się 127.0.0.1, instancja jest dostępna wyłącznie z samego serwera.

W zależności od konfiguracji sieci i miejsca hostowania instancji Overleaf może być konieczne wprowadzenie dodatkowych zmian w konfiguracji. Więcej informacji znajdziesz w ustawieniach Toolkit: toolkit-settings.md