> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Toolkit-asetukset

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.

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

## Kontit

### `sharelatex`

| Nimi | Kuvaus |
| - | - |
| `PROJECT_NAME` | <p>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.<br /><br />- <strong>Oletus</strong>: `overleaf`</p> |
| `OVERLEAF_IMAGE_NAME` | <p>Server Pro/CE-sovelluskontin käyttämä Docker-image. Tämä on pelkkä Docker-imagen nimi; Docker-imagen tagi luetaan tiedostosta `config/version`.<br /><br />- <strong>Oletus:</strong><br />- Server Pro: `ghcr.io/ayaka-notes/overleaf-pro`<br />- Community Edition: `sharelatex/sharelatex`</p> |
| `SERVER_PRO` | <p>Kun arvoksi asetetaan `true`, Toolkit käyttää Server Pro -imagea (`ghcr.io/ayaka-notes/overleaf-pro`) oletusarvoisen Server CE -imagen (`sharelatex/sharelatex`) sijaan.<br /><br />- <strong>Oletus</strong>: `false`</p> |
| `GIT_BRIDGE_ENABLED` | <p>Aseta arvoksi `true` ottaaksesi git-bridge-ominaisuuden käyttöön (vain Server Pro). Lisätietoja on käyttäjädokumentaatiossa <a href="https://www.overleaf.com/learn/how-to/Git_integration">[https://www.overleaf.com/learn/how-to/Git\_integration](https://www.overleaf.com/learn/how-to/Git_integration)</a>.<br /><br />- <strong>Oletus:</strong> `false`</p> |
| `GIT_BRIDGE_IMAGE` | <p>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`.<br /><br />- <strong>Oletus:</strong> `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`</p> |
| `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` | <p>Määrittää `git-bridge`-kontin lokitustason. Käytettävissä olevat tasot: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`.<br /><br />- <strong>Oletus:</strong> `INFO`</p> |
| `SIBLING_CONTAINERS_ENABLED` | <p>Kun arvoksi asetetaan `true`, Toolkit käyttää <strong>Sibling Containers</strong> -tekniikkaa projektien kääntämiseen erillisissä hiekkalaatikoissa, jolloin jokaisella projektilla on oma Docker-konttinsa. Lisätietoja on dokumentaatiossa \<server-pro-only-configuration/sandboxed-compiles>.<br /><br />- <strong>Edellyttää:</strong> `SERVER_PRO=true`<br />- <strong>Oletus:</strong> `true`</p> |
| `SIBLING_CONTAINERS_PULL` | <p>Kun arvoksi asetetaan `true`, Toolkit hakee `bin/up`-komentoa käytettäessä automaattisesti kaikki TeX Live -imaget, jotka on asetettu <strong>config/variables.env</strong>-tiedoston `ALL_TEX_LIVE_DOCKER_IMAGES`-muuttujalla.<br /><br />- <strong>Oletus:</strong> `true`</p> |
| `DOCKER_SOCKET_PATH` | <p>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ä.<br /><br />- <strong>Edellyttää:</strong> `SIBLING_CONTAINERS_ENABLED=true`<br />- <strong>Oletus:</strong> `/var/run/docker.sock`</p> |
| `OVERLEAF_DATA_PATH` | <p>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.<br /><br />- <strong>Oletus:</strong> `data/overleaf`</p> |
| `OVERLEAF_LISTEN_IP` | <p>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ä.<br /><br />- <strong>Oletus:</strong> `127.0.0.1`</p> |
| `OVERLEAF_PORT` | <p>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`.<br /><br />- <strong>Oletus:</strong> `80`</p> |
| `OVERLEAF_LOG_PATH` | <p>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.<br /><br />Katso lisätietoja lokituksesta.<br /><br />- <strong>Oletus:</strong> ei asetettu</p> |

***

### `mongo`

| Nimi | Kuvaus |
| - | - |
| `MONGO_ENABLED` | <p>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.<br /><br />- <strong>Oletus</strong>: `true`</p> |
| `MONGO_URL` | <p>Määrittää MongoDB-yhteyden URL-osoitteen, jota käytetään, kun `MONGO_ENABLED` on `false`.<br /><br />- <strong>Oletus</strong>: ei asetettu</p> |
| `MONGO_DATA_PATH` | <p>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`.<br /><br />- <strong>Oletus</strong>: `data/mongo`</p> |
| `MONGO_IMAGE` | <p>MongoDB-kontin käyttämä Docker-image. Tämä on pelkkä Docker-imagen nimi; Docker-imagen tagi annetaan `MONGO_VERSION`-muuttujassa (katso alla).<br /><br />- <strong>Oletus:</strong> `mongo`</p> |
| `MONGO_VERSION` | <p>MongoDB-kontin käyttämä MongoDB-versio. Arvon on alettava MongoDB:n pääversiolla ja pisteellä, esim. `6.0` tai `6.0-with-suffix`.<br /><br />- <strong>Oletus:</strong> `6.0`</p> |

***

### `redis`

| Nimi | Kuvaus |
| - | - |
| `REDIS_ENABLED` | <p>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.<br /><br />- <strong>Oletus</strong>: `true`</p> |
| `REDIS_HOST` | <p>Määrittää Redis-isännän, jota käytetään, kun `REDIS_ENABLED` on `false`.<br /><br />- <strong>Oletus</strong>: ei asetettu</p> |
| `REDIS_PORT` | <p>Määrittää Redis-portin, jota käytetään, kun `REDIS_ENABLED` on `false`.<br /><br />- <strong>Oletus</strong>: ei asetettu</p> |
| `REDIS_DATA_PATH` | <p>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`.<br /><br />- <strong>Oletus</strong>: `data/redis`</p> |
| `REDIS_AOF_PERSISTENCE` | <p>Ottaa käyttöön Redisin AOF (Append Only File) -pysyvyyden. Tämä on <strong>suositeltu</strong> määritys Redisin pysyvyydelle.<br /><br />Lisätietoja on osiossa \<../../../maintenance/data-and-backups#aof-append-only-file> sivulla \<../../maintenance/data-and-backups>.<br /><br />- <strong>Oletus:</strong> `true`</p> |

***

### `nginx`

| Nimi | Kuvaus |
| - | - |
| `NGINX_ENABLED` | <p>Kun arvoksi asetetaan `true`, Toolkit luo NGINX-kontin toimimaan TLS-välityspalvelimena.<br /><br />- <strong>Oletus</strong>: `false`</p> |
| `NGINX_CONFIG_PATH` | <p>Polku TLS-välityspalvelimen käyttämään NGINX-määritystiedostoon.<br /><br />- <strong>Oletus</strong>: `config/nginx/nginx.conf`</p> |
| `NGINX_TLS_LISTEN_IP` | <p>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.<br /><br />- <strong>Oletus</strong>: `127.0.1.1`</p> |
| `NGINX_HTTP_LISTEN_IP` | <p>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.<br /><br />- <strong>Oletus</strong>: `127.0.1.1`</p> |
| `NGINX_HTTP_PORT` | <p>Asettaa isännän portin, johon TLS-välityspalvelinkontti sidotaan HTTP:tä varten.<br /><br />- <strong>Oletus</strong>: `80`</p> |
| `TLS_PORT` | <p>Asettaa isännän portin, johon TLS-välityspalvelinkontti sidotaan HTTPS:ää varten.<br /><br />- <strong>Oletus</strong>: `443`</p> |
| `TLS_PRIVATE_KEY_PATH` | <p>Polku TLS-välityspalvelimen käyttämään yksityiseen avaimeen.<br /><br />- <strong>Oletus</strong>: `config/nginx/certs/overleaf_key.pem`</p> |
| `TLS_CERTIFICATE_PATH` | <p>Polku TLS-välityspalvelimen käyttämään julkiseen varmenteeseen.<br /><br />- <strong>Oletus</strong>: `config/nginx/certs/overleaf_certificate.pem`</p> |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.