Ympäristömuuttujat

Tällä sivulla kuvataan ympäristömuuttujat, joita Toolkit-käyttöönotoissa tuetaan tiedostossa config/variables.env.

Tiedosto config/variables.env koostuu muuttujamäärittelyistä muodossa NAME=value; #-merkillä alkavat rivit käsitellään kommentteina.

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

​

Kaikki versiot

Nämä ympäristömuuttujat ovat yhteensopivia Server CE:n ja Server Pron kanssa, ja ne tarjoavat helpon siirtymäpolun näiden kahden paikallisen version välillä. Niitä voidaan käyttää sekä Toolkit- että Docker Compose -käyttöönotoissa.

Aiemmin näiden ympäristömuuttujien etuliite oli SHARELATEX_ eikä OVERLEAF_.

Nimi	Kuvaus
OVERLEAF_SITE_URL	Osoite, jossa Overleaf-instanssisi on julkisesti saatavilla. Tätä käytetään julkisissa linkeissä ja websocket-yhteyksiä muodostettaessa, joten se on määritettävä oikein!
OVERLEAF_ADMIN_EMAIL	Sähköpostiosoite, josta käyttäjät tavoittavat sivuston ylläpitäjän.
OVERLEAF_APP_NAME	Nimi, joka näytetään puhuttaessa käynnissä olevasta sovelluksesta. Oletusarvo on ‘Overleaf (Community Edition)’.
OVERLEAF_MONGO_URL ja MONGO_URL	Käytettävän Mongo-tietokannan URL-osoite.
OVERLEAF_REDIS_HOST ja REDIS_HOST	Käytettävän Redis-instanssin isäntänimi. Molemmat ovat pakollisia (katso julkaisutiedot).
OVERLEAF_REDIS_PORT ja REDIS_PORT	Käytettävän Redis-instanssin portti. Molemmat ovat pakollisia (katso julkaisutiedot).
OVERLEAF_REDIS_PASS ja REDIS_PASSWORD	Salasana, jota käytetään Redisiin yhdistettäessä (tarvittaessa). Molemmat ympäristömuuttujat on asetettava. Lisätietoja on kohdassa salasanatodennuksen käyttöönotto.
OVERLEAF_REDIS_TLS	Jos arvoksi asetetaan true, sallii yhteyden TLS:ää vaativaan Redis-instanssiin. Huomio: mTLS:ää ei tällä hetkellä tueta.
OVERLEAF_NAV_TITLE	Asettaa sovelluksen välilehden otsikon.
OVERLEAF_HEADER_IMAGE_URL_LIGHT ja OVERLEAF_HEADER_IMAGE_URL_DARK	Mukautettujen ylätunnistelogojen URL-osoitteet vaaleaa ja tummaa teemaa varten (lisätty versiossa 6.3.0). Kumpikin teema käyttää varavaihtoehtona muuttujaa OVERLEAF_HEADER_IMAGE_URL, jos teemakohtaista muuttujaa ei ole asetettu. Katso Branding.
OVERLEAF_LINKED_URL_OUTBOUND_PROXY	HTTP(S)-välityspalvelimen URL-osoite, jonka kautta haetaan ulkoisia linkitettyjä tiedostoja sekä ulkoisia ZIP- tai TeX-resursseja Open in Overleaf -API:n kautta. Saatavilla uudelleenjulkaistusta Ayakaleaf Pro -versiosta 6.3.0 (3. lokakuuta 2026) alkaen. Jätä asettamatta, jos haluat yhdistää suoraan. Esimerkki: OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128. Katso määritykset ja verkkoyhteyksien rajoitukset kohdasta Outbound Proxy.
OVERLEAF_INVITE_TOKEN_SECRET	Pakollinen. Satunnainen merkkijono, jota käytetään projektien jakotunnisteiden suojaamiseen (lisätty Server Pron versiossa 6.2.0). Vähimmäispituus merkkeinä: 16
OVERLEAF_SESSION_SECRET	Satunnainen merkkijono, jota käytetään tunnisteiden suojaamiseen; kuormantasausta käytettäessä tämän on oltava sama kaikilla palvelimilla. Jos käytössä on vain yksi instanssi, käyttäjän ei tarvitse asettaa sitä.
OVERLEAF_COOKIE_SESSION_LENGTH	Mahdollistaa istuntoevästeen oletusarvoisen 5 päivän voimassaoloajan ohittamisen. Arvo annetaan millisekunteina. Esimerkki: jos haluat istunnon kestävän 1 tunnin, aseta COOKIE_SESSION_LENGTH=3600000. (Lisätty Server Pron versiossa 4.2)
OVERLEAF_TRUSTED_PROXY_IPS	Jos tätä ei ole asetettu, oletusarvo on loopback. Jos asetat arvon manuaalisesti, sinun on luotettujen IP-osoitteidesi lisäksi sisällytettävä myös loopback (tai 127.0.0.1), joka luottaa sharelatex-kontin sisällä ajettavaan nginx-instanssiin. Vain IP-osoitteet ja CIDR-alueet hyväksytään: älä lisää isäntänimiä, kuten localhost, muuten Overleaf ei käynnisty ja palauttaa virheen 502 Bad Gateway. Jos tavallisessa verkossasi käytetään aliverkkoa alueelta 172.16.0.0/12 (Docker-verkkojen oletusaliverkko), aseta OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network> tiedostoon config/variables.env. Tässä <network> on komennon docker inspect overleaf_default tulosteen arvo IPAM -> Config -> Subnet, esim. OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16. Tämä estää X-Forwarded-otsakkeiden väärentämisen. Jos käytät ulkoista TLS-välityspalvelinta (eli sellaista, jota Overleaf Toolkit ei hallinnoi), varmista, että OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>, esim. OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37.
OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS	Jos arvoksi asetetaan true, projektikutsut rajoitetaan sähköpostiosoitteisiin, jotka vastaavat olemassa olevia käyttäjätilejä.
OVERLEAF_ALLOW_PUBLIC_ACCESS	Jos arvoksi asetetaan true, kirjautumattomat käyttäjät voivat tarkastella sivustoa. Oletusarvo on false, jolloin kirjautumattomat käyttäjät ohjataan ehdoitta kirjautumissivulle, kun he yrittävät avata minkä tahansa sivuston osan. Huomaa, että tämän asetuksen määrittäminen ei millään tavalla poista todennusta tai tietoturvaa käytöstä. Tämä asetus on välttämätön, jos käyttäjäsi aikovat tehdä projekteistaan julkisia ja antaa kirjautumattomien käyttäjien tarkastella niitä.
OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING	Jos arvoksi asetetaan true, anonyymit käyttäjät voivat tarkastella ja muokata linkkijako-ominaisuuden kautta jaettuja projekteja.
OVERLEAF_DISABLE_LINK_SHARING	Poistaa linkkijako-ominaisuuden käytöstä.
EMAIL_CONFIRMATION_DISABLED	Kun arvoksi asetetaan true, sähköpostiosoitteen vahvistamista pyytävää banneria ei näytetä.
ADDITIONAL_TEXT_EXTENSIONS	Merkkijonotaulukko, jolla määritetään muokattavien tiedostojen lisätiedostopäätteet.
DEFAULT_LATEX_COMPILER	Asettaa oletuskääntäjän, jota uudet projektit käyttävät. (Lisätty Server Pron versiossa 6.2.0). Vaihtoehdot: pdflatex, latex, xelatex tai lualatex
OVERLEAF_STATUS_PAGE_URL	Mukautetun tilasivun URL-osoite (lisätty Server Pron versiossa 3.4.0), esim. status.example.com.
OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS	Aseta arvoksi 'false', jos haluat estää uusien projektien alustamisen Full Project History -historialla (lisätty Server Pron versiossa 3.5.0).
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS	Aseta arvoksi 'false', jos haluat estää uusia projekteja näyttämästä Full Project History -historiaa vanhan historian sijaan (lisätty Server Pron versiossa 3.5.0).
ENABLE_CRON_RESOURCE_DELETION	Aseta tämän ympäristömuuttujan arvoksi true, jos haluat ottaa käyttöön poistettujen projektien ja käyttäjien automaattisen siivouksen 90 päivän kuluttua.
OVERLEAF_USER_HARD_DELETION_DELAY	Muuttaa poistettujen käyttäjien vanhenemisviivettä. Määritetään millisekunteina. Oletus: 90 päivää
OVERLEAF_PROJECT_HARD_DELETION_DELAY	Muuttaa poistettujen projektien vanhenemisviivettä. Määritetään millisekunteina. Oletus: 90 päivää
MAX_UPLOAD_SIZE	Määrittää yksittäisen latauksen enimmäiskoon megatavuina. Oletusarvo on 50. Huomio: Tämä muuttuja on pelkkä luku ilman yksikköä (MB) tai muuta merkintää. Ladatun .zip-tiedoston pakkaamaton kokonaiskoko on rajoitettu 6 × tähän arvoon (oletuksena 300 MB).
COMPILE_SIZE_LIMIT	Määrittää pyynnön rungon enimmäiskoon tavuina. Tämä on projektin kaikkien dokumenttitiedostojen (main.tex, references.bib (jos ei linkitetty) jne.) yhteenlaskettu koko, joka on lähetettävä CLSI-palvelulle ensimmäisessä käännöspyynnössä.
COMPILE_TIMEOUT	Aika sekunteina, jonka kuluessa käännöksen on valmistuttava. Lisätietoja on kohdassa Projektin käännöksen aikakatkaisun päivittäminen.
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	Määritettävä viive editorin hallitun uudelleenyhdistämisen, datan tallentamisen ja kontin sammuttamisen välillä tietojen menetyksen riskin pienentämiseksi.
SECCOMP_PROFILE	Aseta tämän ympäristömuuttujan arvoksi Docker-isäntäkoneella oleva polku, joka osoittaa SECCOMP-profiiliin. Voit ladata kopion profiilista täältä. Tarvitaan tällä hetkellä Podman-käyttöönotoissa, kun käytetään hiekkalaatikkokäännöksiä.
OVERLEAF_DISABLE_CHAT	Jos arvoksi asetetaan true, projektin sisäinen chat-ominaisuus poistetaan käytöstä.
OVERLEAF_LOGIN_SUPPORT_TEXT	Kun tämä on asetettu, sen avulla voidaan näyttää tukitietoja kirjautumispainikkeen alapuolella. Teksti näytetään kirjautumisnäytössä, ja sen avulla voidaan ohjata käyttäjiä sisäiseen tukeen tai antaa ohjeita kirjautumiseen, tilien luomiseen jne.
ALLOW_MONGO_ADMIN_CHECK_FAILURES	Jos arvoksi asetetaan true, MongoDB:n käynnistystarkistukset saavat epäonnistua estämättä käyttöönoton käynnistymistä. Tämä voi olla tarpeen, jos käytät MongoDB-tietokantaa, jonka tietokantakäyttäjällä ei ole roolia clusterParameterReader. Ohjeita mukautetun roolin luomiseen löydät täältä.
V1_HISTORY_URL_FOR_GIT_BRIDGE	Mahdollistaa history-v1-päätepisteen erottamisen sisäiselle liikenteelle (web-palvelu → history-v1-palvelu, molemmat sharelatex-kontissa) ja ulkoiselle liikenteelle (git-bridge → history-v1, ajetaan erillisissä konteissa).
OVERLEAF_MAINTENANCE_MESSAGE ja OVERLEAF_MAINTENANCE_MESSAGE_HTML	Käytetään huoltosivun otsikon ja sisällön mukauttamiseen. Ei voi käyttää yhdessä muuttujan OVERLEAF_STATUS_PAGE_URL kanssa.

Käyttäjille on mahdollista asettaa salasanarajoituksia, kun käytetään Overleafin omaa kirjautumisjärjestelmää (paikalliset tilit) eikä SSO-vaihtoehtoa, kuten LDAP:ia. SSO-tileillä salasanakäytännöt valvoo identiteetintarjoajasi tai hakemistopalvelusi, mikä mahdollistaa lisäksi monivaiheisen todennuksen tuen.