5. Instanssin mukauttaminen

​

Instanssin mukauttaminen

Ennen kuin käynnistät Overleaf-instanssisi ensimmäistä kertaa, päivitä kahteen määritystiedostoon omat tietosi:

Tiedosto	Lukija	Määritetään tässä
config/overleaf.rc	Toolkitin skriptit, kuten bin/up	miten kontit ajetaan: OVERLEAF_LISTEN_IP, OVERLEAF_PORT, SERVER_PRO, datapolut
config/variables.env	kontin sisällä toimiva sovellus	miten Overleaf toimii: OVERLEAF_SITE_URL, sähköposti, TeX Live -imaget

1. Muokkaa muuttujatiedostoa

   Avaa config/variables.env haluamassasi tekstieditorissa ja päivitä alla olevat ympäristömuuttujat tarvittavilla arvoilla.

2. Kuunteluosoite ja portti

   Oletuksena Toolkit julkaisee verkkokäyttöliittymän osoitteessa 127.0.0.1:80, joten sen voi avata vain itse palvelimella toimivasta selaimesta. Muut tietokoneet saavat virheen “connection refused” tai “server not found”. Voit muuttaa tätä muokkaamalla tiedostoa config/overleaf.rc:

   config/overleaf.rc

   OVERLEAF_LISTEN_IP=0.0.0.0
   OVERLEAF_PORT=8080
   

   OVERLEAF_LISTEN_IP on isännän IP-osoite, johon kontti sidotaan, ja OVERLEAF_PORT on isännän portti. Yhdessä ne muodostavat Dockerin porttimäärityksen OVERLEAF_LISTEN_IP:OVERLEAF_PORT:80. Valitse kokoonpanoasi vastaavat arvot:

   Kokoonpano	OVERLEAF_LISTEN_IP	OVERLEAF_PORT	Avaa selaimessa
   Vain tällä koneella (oletus)	127.0.0.1	80	http://localhost
   Lähiverkon tai internetin muut tietokoneet yhdistävät suoraan	0.0.0.0 tai jokin palvelimen IP-osoite	80 tai mikä tahansa vapaa portti	http://<server-ip>:<port>
   Oman käänteisen välityspalvelimen (NGINX, Caddy, Cloudflare Tunnel) takana samassa isännässä	127.0.0.1	mikä tahansa vapaa portti	välityspalvelimen URL-osoite
   Toolkitin TLS-välityspalvelimen takana	127.0.0.1	80	https://<your-domain>

   Jos portti 80 on jo käytössä isännässä, esimerkiksi toisen verkkopalvelimen toimesta, aseta OVERLEAF_PORT vapaaseen porttiin, kuten 8080. Muuten bin/up epäonnistuu virheeseen bind: address already in use.

   Dockerin julkaisemat portit ohittavat isännän palomuurit, kuten ufw ja firewalld. Arvolla 0.0.0.0 instanssi on tavoitettavissa jokaisesta verkosta, johon palvelin on yhdistetty. Pilvipalvelimella portti on sallittava myös palveluntarjoajan suojausryhmässä. Ota HTTPS käyttöön ennen kuin avaat instanssin internetiin, katso TLS-välityspalvelin.

   Voit aloittaa oletusarvoilla ja avata instanssin ensin osoitteessa localhost. Jos haluat myöhemmin sallia pääsyn muilta tietokoneilta, muuta nämä kaksi muuttujaa tiedostossa config/overleaf.rc sekä OVERLEAF_SITE_URL tiedostossa config/variables.env, ja aja sitten bin/up uudelleen konttien luomiseksi uudelleen.

3. Pakolliset ympäristömuuttujat

   Päivitä seuraavat muuttujat tiedostossa config/variables.env:

   Nimi	Kuvaus	Esimerkki
   OVERLEAF_SITE_URL	Osoite, jossa Overleaf-instanssisi on julkisesti saatavilla. Tätä käytetään julkisissa linkeissä ja websocket-yhteyksissä, joten sen on oltava määritetty oikein!	https://overleaf.lilliput.com
   OVERLEAF_EMAIL_FROM_ADDRESS	Tätä sähköpostiosoitetta käytetään kaikkien lähtevien sähköpostien from-osoitteena.	[e-mail]
   OVERLEAF_ADMIN_EMAIL	Sähköpostiosoite, josta käyttäjät tavoittavat sivuston ylläpitäjän.	[e-mail]

   OVERLEAF_SITE_URL on osoite, jonka käyttäjät kirjoittavat selaimeensa, ei kuunteluosoite. Sisällytä portti, kun se ei ole 80 (HTTP) tai 443 (HTTPS), esimerkiksi http://192.168.1.20:8080. Älä käytä osoitetta http://0.0.0.0. Jos OVERLEAF_SITE_URL ei vastaa selaimen osoitetta, editori ei saa yhteyttä, ja sähköpostien linkit sekä OAuth-takaisinkutsut osoittavat väärään paikkaan.

   Jos sinulla ei ole sähköpostipalvelinta, jätä OVERLEAF_EMAIL_FROM_ADDRESS asettamatta: tällöin Overleaf ei lähetä sähköposteja, ja voit antaa uusille käyttäjille heidän aktivointilinkkinsä itse, katso kysymykset ja vastaukset sivulla Julkinen pääsy.

   Aseta myös OVERLEAF_SESSION_SECRET arvoon, joka on luotu komennolla openssl rand -hex 32. Ilman sitä jokainen konttia uudelleen luova bin/up ja jokainen päivitys kirjaa kaikki käyttäjät ulos. Katso kysymykset ja vastaukset sivulla Ympäristömuuttujat.

   Kun olet päivittänyt nämä ympäristömuuttujat, tallenna ja sulje tiedosto.

4. Määritä Sandbox Compile

   Määritä seuraavaksi TeX Live Full sandboxed-compiles.md -toimintoa varten. Avaa config/variables.env ja päivitä seuraavat ympäristömuuttujat:

   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. Käynnistä instanssi

   Käynnistä instanssi ajamalla:

   Start the instance

   bin/up
   

   Tämä komento lataa tarvittavat imaget texlive mukaan lukien, luo kontit (mukautuksiasi käyttäen) ja käynnistää instanssin. Sinun pitäisi nähdä lokitulosteita eri Docker-konteista.

   Kun haluat myöhemmin käynnistää ne uudelleen (liittymättä lokitulosteeseen), aja:

   Start without attaching to logs

   bin/start
   

Toolkit hallitsee Overleafin Docker-kontteja docker compose -työkalulla. Toolkit tarjoaa joukon skriptejä, jotka käärivät docker compose -komennon ja hoitavat useimmat yksityiskohdat puolestasi.

Jos kaikki menee hyvin, näet uuden Overleaf-instanssisi kirjautumissivun siirtymällä selaimessasi osoitteeseen http://127.0.0.1/ tai http://localhost/. Jos muutit OVERLEAF_LISTEN_IP- tai OVERLEAF_PORT-arvoa, avaa sen sijaan Kuunteluosoite ja portti -vaiheen taulukon mukainen osoite, esimerkiksi http://<server-ip>:8080.

Voit tarkistaa, missä osoitteessa ja portissa verkkokäyttöliittymä on julkaistu, ajamalla:

Show the published port

bin/docker-compose port sharelatex 80

Tuloste, esimerkiksi 0.0.0.0:8080, näyttää käytössä olevan isännän IP-osoitteen ja portin. Jos se näyttää 127.0.0.1, instanssi on tavoitettavissa vain itse palvelimelta.

Verkkoasetuksistasi ja Overleaf-instanssisi sijainnista riippuen saatat joutua tekemään lisämäärityksiä. Lisätietoja on Toolkitin asetuksissa: toolkit-settings.md