Toolkit-asetukset - Ayakaleaf Pro

Tällä sivulla kuvataan ympäristömuuttujat, joita Toolkit-käyttöönottojen config/overleaf.rc-tiedosto tukee. config/overleaf.rc-tiedosto koostuu muuttujamäärityksistä muodossa NAME=value. #-merkillä alkavat rivit tulkitaan kommenteiksi.

Docker-kontit on luotava uudelleen ajamalla bin/up aina, kun muutat jotakin overleaf.rc- tai variables.env-tiedostossa.

Kontit

`sharelatex`

Nimi	Kuvaus
`PROJECT_NAME`	Asettaa `docker-compose`-komennolle annettavan `--project-name`-lipun arvon. Tämä on hyödyllistä ajettaessa useita Overleaf-instansseja samalla isännällä, koska kullakin instanssilla voi olla eri projektinimi. - Oletus: `overleaf`
`OVERLEAF_IMAGE_NAME`	Server Pro/CE-sovelluskontin käyttämä Docker-image. Tämä on pelkkä Docker-imagen nimi; Docker-imagen tagi luetaan tiedostosta `config/version`. - Oletus: - Server Pro: `ghcr.io/ayaka-notes/overleaf-pro` - Community Edition: `sharelatex/sharelatex`
`SERVER_PRO`	Kun arvoksi asetetaan `true`, Toolkit käyttää Server Pro -imagea (`ghcr.io/ayaka-notes/overleaf-pro`) oletusarvoisen Server CE -imagen (`sharelatex/sharelatex`) sijaan. - Oletus: `false`
`GIT_BRIDGE_ENABLED`	Aseta arvoksi `true` ottaaksesi git-bridge-ominaisuuden käyttöön (vain Server Pro). Lisätietoja on käyttäjädokumentaatiossa https://www.overleaf.com/learn/how-to/Git_integration. - Oletus: `false`
`GIT_BRIDGE_IMAGE`	git-bridge-kontin käyttämä Docker-image (vain Server Pro). Tämä on pelkkä Docker-imagen nimi; Docker-imagen tagi luetaan tiedostosta `config/version`. - Oletus: `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`
`GIT_BRIDGE_DATA_PATH`	Asettaa polun hakemistoon, joka liitetään `git-bridge`-konttiin (vain Server Pro) ja jota käytetään git-repositorioiden tallentamiseen. Se voi olla joko täydellinen polku (alkaa merkillä `/`) tai suhteellinen polku Toolkitin perushakemistoon.
`GIT_BRIDGE_LOG_LEVEL`	Määrittää `git-bridge`-kontin lokitustason. Käytettävissä olevat tasot: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`. - Oletus: `INFO`
`SIBLING_CONTAINERS_ENABLED`	Kun arvoksi asetetaan `true`, Toolkit käyttää Sibling Containers -tekniikkaa projektien kääntämiseen erillisissä hiekkalaatikoissa, jolloin jokaisella projektilla on oma Docker-konttinsa. Lisätietoja on dokumentaatiossa <server-pro-only-configuration/sandboxed-compiles>. - Edellyttää: `SERVER_PRO=true` - Oletus: `true`
`SIBLING_CONTAINERS_PULL`	Kun arvoksi asetetaan `true`, Toolkit hakee `bin/up`-komentoa käytettäessä automaattisesti kaikki TeX Live -imaget, jotka on asetettu config/variables.env-tiedoston `ALL_TEX_LIVE_DOCKER_IMAGES`-muuttujalla. - Oletus: `true`
`DOCKER_SOCKET_PATH`	Asettaa Docker-socketin polun isäntäkoneella (koneella, jolla Toolkit toimii). Kun `SIBLING_CONTAINERS_ENABLED` on `true`, socket liitetään konttiin, jotta käännöspalvelu voi käynnistää uusia Docker-kontteja isännällä. - Edellyttää: `SIBLING_CONTAINERS_ENABLED=true` - Oletus: `/var/run/docker.sock`
`OVERLEAF_DATA_PATH`	Asettaa polun hakemistoon, joka liitetään pää-`sharelatex`-konttiin ja jota käytetään käännösdatan tallentamiseen. Se voi olla joko täydellinen polku (alkaa merkillä `/`) tai suhteellinen polku Toolkitin perushakemistoon. - Oletus: `data/overleaf`
`OVERLEAF_LISTEN_IP`	Asettaa isännän IP-osoitteet, joihin kontti sidotaan. Jos arvoksi asetetaan esimerkiksi `0.0.0.0`, verkkokäyttöliittymä on käytettävissä kaikissa isännän IP-osoitteissa. Suoraa konttiyhteyttä varten `OVERLEAF_LISTEN_IP`-arvoksi on asetettava julkinen IP-osoitteesi. Jos `OVERLEAF_LISTEN_IP` asetetaan arvoon `0.0.0.0` tai isännän ulkoiseen IP-osoitteeseen, se aiheuttaa tyypillisesti virheitä yhdessä kanssa käytettynä. - Oletus: `127.0.0.1`
`OVERLEAF_PORT`	Asettaa isännän portin, johon kontti sidotaan. Jos arvoksi asetetaan esimerkiksi `8099` ja `OVERLEAF_LISTEN_IP` on `127.0.0.1`, verkkokäyttöliittymä on käytettävissä osoitteessa `http://localhost:8099`. - Oletus: `80`
`OVERLEAF_LOG_PATH`	Asettaa polun hakemistoon, joka liitetään pää-`sharelatex`-konttiin ja jonka kautta sovelluslokit saadaan Docker-isännän käyttöön. Se voi olla joko täydellinen polku (alkaa merkillä `/`) tai suhteellinen polku Toolkitin perushakemistoon. Poista määritysmerkintä poistaaksesi bind-mount-liitoksen käytöstä. Jos arvoa ei ole asetettu, lokit hävitetään, kun kontti luodaan uudelleen. Katso lisätietoja lokituksesta. - Oletus: ei asetettu

`mongo`

Nimi	Kuvaus
`MONGO_ENABLED`	Kun arvoksi asetetaan `true`, Toolkit luo MongoDB-kontin tietokantaa varten. Kun arvoksi asetetaan `false`, konttia ei luoda, ja järjestelmä käyttää sen sijaan `MONGO_URL`-muuttujalla määritettyä MongoDB-tietokantaa. - Oletus: `true`
`MONGO_URL`	Määrittää MongoDB-yhteyden URL-osoitteen, jota käytetään, kun `MONGO_ENABLED` on `false`. - Oletus: ei asetettu
`MONGO_DATA_PATH`	Asettaa polun hakemistoon, joka liitetään `mongo`-konttiin ja jota käytetään MongoDB-tietokannan tallentamiseen. Se voi olla joko täydellinen polku (alkaa merkillä `/`) tai suhteellinen polku Toolkitin perushakemistoon. Tämä asetus vaikuttaa vain paikalliseen `mongo`-konttiin, joka luodaan, kun `MONGO_ENABLED` on `true`. - Oletus: `data/mongo`
`MONGO_IMAGE`	MongoDB-kontin käyttämä Docker-image. Tämä on pelkkä Docker-imagen nimi; Docker-imagen tagi annetaan `MONGO_VERSION`-muuttujassa (katso alla). - Oletus: `mongo`
`MONGO_VERSION`	MongoDB-kontin käyttämä MongoDB-versio. Arvon on alettava MongoDB:n pääversiolla ja pisteellä, esim. `6.0` tai `6.0-with-suffix`. - Oletus: `6.0`

`redis`

Nimi	Kuvaus
`REDIS_ENABLED`	Kun arvoksi asetetaan `true`, Toolkit luo Redis-kontin Redis-tietokantaa varten. Kun arvoksi asetetaan `false`, konttia ei luoda, ja järjestelmä käyttää sen sijaan `REDIS_HOST`- ja `REDIS_PORT`-muuttujilla määritettyä Redis-tietokantaa. - Oletus: `true`
`REDIS_HOST`	Määrittää Redis-isännän, jota käytetään, kun `REDIS_ENABLED` on `false`. - Oletus: ei asetettu
`REDIS_PORT`	Määrittää Redis-portin, jota käytetään, kun `REDIS_ENABLED` on `false`. - Oletus: ei asetettu
`REDIS_DATA_PATH`	Asettaa polun hakemistoon, joka liitetään `redis`-konttiin ja jota käytetään Redis-tietokannan tallentamiseen. Se voi olla joko täydellinen polku (alkaa merkillä `/`) tai suhteellinen polku Toolkitin perushakemistoon. Tämä asetus vaikuttaa vain paikalliseen `redis`-konttiin, joka luodaan, kun `REDIS_ENABLED` on `true`. - Oletus: `data/redis`
`REDIS_AOF_PERSISTENCE`	Ottaa käyttöön Redisin AOF (Append Only File) -pysyvyyden. Tämä on suositeltu määritys Redisin pysyvyydelle. Lisätietoja on osiossa <../../../maintenance/data-and-backups#aof-append-only-file> sivulla <../../maintenance/data-and-backups>. - Oletus: `true`

`nginx`

Nimi	Kuvaus
`NGINX_ENABLED`	Kun arvoksi asetetaan `true`, Toolkit luo NGINX-kontin toimimaan TLS-välityspalvelimena. - Oletus: `false`
`NGINX_CONFIG_PATH`	Polku TLS-välityspalvelimen käyttämään NGINX-määritystiedostoon. - Oletus: `config/nginx/nginx.conf`
`NGINX_TLS_LISTEN_IP`	Asettaa isännän IP-osoitteet, joihin TLS-välityspalvelinkontti sidotaan HTTPS:ää varten. Jos arvoksi asetetaan esimerkiksi `0.0.0.0`, HTTPS-verkkokäyttöliittymä on käytettävissä kaikissa isännän IP-osoitteissa. Tyypillisesti arvoksi tulisi asettaa isännän ulkoinen IP-osoite. - Oletus: `127.0.1.1`
`NGINX_HTTP_LISTEN_IP`	Asettaa isännän IP-osoitteet, joihin TLS-välityspalvelinkontti sidotaan HTTP-uudelleenohjausta varten. Jos arvoksi asetetaan esimerkiksi `127.0.1.1`, HTTP-yhteydet osoitteeseen `127.0.1.1` ohjataan HTTPS-verkkokäyttöliittymään. Tyypillisesti arvoksi tulisi asettaa isännän ulkoinen IP-osoite. Älä aseta arvoksi `0.0.0.0`, koska se aiheuttaa tyypillisesti ristiriidan `OVERLEAF_LISTEN_IP`-asetuksen kanssa. - Oletus: `127.0.1.1`
`NGINX_HTTP_PORT`	Asettaa isännän portin, johon TLS-välityspalvelinkontti sidotaan HTTP:tä varten. - Oletus: `80`
`TLS_PORT`	Asettaa isännän portin, johon TLS-välityspalvelinkontti sidotaan HTTPS:ää varten. - Oletus: `443`
`TLS_PRIVATE_KEY_PATH`	Polku TLS-välityspalvelimen käyttämään yksityiseen avaimeen. - Oletus: `config/nginx/certs/overleaf_key.pem`
`TLS_CERTIFICATE_PATH`	Polku TLS-välityspalvelimen käyttämään julkiseen varmenteeseen. - Oletus: `config/nginx/certs/overleaf_certificate.pem`

Viimeksi muokattu 5. lokakuuta 2026