Ayakaleaf Pro stöder horisontell skalning. Vi har testat och verifierat att det fungerar korrekt med flera repliker.
Krav

Extern, central datalagring
Datalagringen i Ayakaleaf Pro kan delas upp i fyra datalager:-
MongoDB
- Merparten av data lagras persistent i MongoDB.
- Vi stöder antingen en lokal instans eller en extern instans, såsom MongoDB Atlas (en fullt hanterad MongoDB-tjänst som körs inom AWS-infrastrukturen).
-
Redis
- Redis lagrar tillfälliga data, till exempel väntande dokumentuppdateringar innan de skrivs till MongoDB.
- Redis används för att förmedla dokumentuppdateringar mellan olika tjänster och för att meddela editorn om tillståndsändringar i ett visst projekt.
- Redis används för att lagra användarsessioner.
- Vi stöder antingen en lokal instans eller en extern instans.
-
Projektfiler och historikfiler
- Icke-redigerbara projektfiler lagras utanför MongoDB. Projekthistoriksystemet lagrar även historiken utanför MongoDB.
- För små enskilda instanser stöder vi antingen ett lokalt filsystem (som kan ligga på en lokal SSD, NFS eller EBS) eller ett S3-kompatibelt datalagringssystem.
-
För horisontell skalning stöder vi endast S3-kompatibla datalagringssystem.
-
Tillfälliga filer
- LaTeX-kompileringar behöver köras på snabba, lokala diskar för optimal prestanda. Kompileringens utdata behöver inte lagras persistent eller säkerhetskopieras.
- Buffring av nya filuppladdningar och skapande av zip-filer för projekt gynnas också av en lokal disk.
Vi rekommenderar starkt att du använder en lokal disk. Att använda någon form av nätverksdisk (som NFS eller EBS) kan leda till oväntade kompileringsfel och andra prestandaproblem.
Git-bridge
Git-repositoryn lagras lokalt på disk. Det finns inga replikeringsalternativ. Git-bridge ska köras som en singleton (en enda instans). För optimal prestanda rekommenderar vi en lokal disk för git-bridge-data. Datadisken för git-bridge bör säkerhetskopieras regelbundet. För datalagringen vid horisontell skalning behöver du:- en central MongoDB-instans som är åtkomlig från alla Ayakaleaf Pro-instanser
- en central Redis-instans som är åtkomlig från alla Ayakaleaf Pro-instanser
- en central S3-kompatibel lagringsbackend för projekt- och historikfiler
- en lokal disk på varje instans för tillfälliga filer
- en lokal disk på den instans som kör git-bridge-containern, för git-bridge-data
Krav på lastbalanseraren
-
Beständig routning (sticky sessions), t.ex. med en cookie
Detta krav kommer från följande komponenter:
- Realtidsredigeringen i Ayakaleaf Pro använder WebSockets med XHR-polling som reserv. Varje redigeringssession har lokalt tillstånd på serversidan, och förfrågningarna i en given redigeringssession måste alltid routas till samma Ayakaleaf Pro-instans. Samarbetsfunktionen använder Redis Pub/Sub för att dela uppdateringar mellan flera Ayakaleaf Pro-instanser.
- LaTeX-kompileringen sparar utdata och kompileringscache lokalt för optimal prestanda. När en kompileringsförfrågan har skickats till en Ayakaleaf Pro-instans måste efterföljande förfrågningar om nedladdning av PDF/logg routas till samma Ayakaleaf Pro-instans.
- Långa tidsgränser för förfrågningar för att stödja kompilering av stora LaTeX-dokument
- Stöd för WebSocket för optimal prestanda
- POST-nyttolast på 50 MB
-
Keep-alive-tidsgränsen måste vara lägre än keep-alive-tidsgränsen i Ayakaleaf Pro
Keep-alive-tidsgränsen i Ayakaleaf Pro kan konfigureras med miljövariabeln
NGINX_KEEPALIVE_TIMEOUT. Standardvärdet är 65 s. Med standardvärdet fungerar en keep-alive-tidsgräns på 60 s i lastbalanseraren. MedNGINX_KEEPALIVE_TIMEOUT=120kan lastbalanseraren välja 115 s. -
Klient-IP-adresser
Sätt förfrågningshuvudet
X-Forwarded-Fortill klientens IP-adress. -
Vid SSL-terminering
Lastbalanseraren måste lägga till förfrågningshuvudet
X-Forwarded-Proto: https.
Exempel på HAProxy-konfiguration
Exempel på HAProxy-konfiguration
Konfiguration av Ayakaleaf Pro
Hemligheter Ayakaleaf Pro-instanserna måste använda samma delade hemligheter:WEB_API_PASSWORD(autentisering för webb-API)STAGING_PASSWORDochV1_HISTORY_PASSWORDmed samma värde (autentisering för historik)CRYPTO_RANDOM(för sessionscookien)OT_JWT_AUTH_KEY(autentisering för historik)OVERLEAF_INVITE_TOKEN_SECRET(token för länkdelning, obligatorisk: utan den vägrar Ayakaleaf Pro att starta)
/dev/urandom (256 slumpmässiga bitar).
OVERLEAF_MONGO_URL peka på den centrala MongoDB-instansen.
Redis
Låt OVERLEAF_REDIS_HOST och REDIS_HOST peka på den centrala Redis-instansen.
S3-kompatibel lagring för projekt- och historikfiler
Se dokumentationen om S3-kompatibel lagring för mer information.
Tillfälliga filer
Den förvalda bind-monteringen av en lokal SSD till /var/lib/overleaf räcker. Se till att låta SANDBOXED_COMPILES_HOST_DIR peka på monteringspunkten på värden.
Vi rekommenderar starkt att du använder en lokal disk. Att använda någon form av nätverksdisk (som NFS eller EBS) kan leda till oväntade kompileringsfel och andra prestandaproblem.
- Sätt
OVERLEAF_TRUSTED_PROXY_IPStillloopbackplus lastbalanserarnas IP-adresser, t.ex.loopback,198.18.0.1, för korrekta klient-IP-adresser. Flera IP-adresser eller CIDR-block kan anges, separerade med kommatecken.
-
Sätt
GIT_BRIDGE_ENABLEDtill'true' -
Sätt
GIT_BRIDGE_HOSTtill<git-bridge container name>, t.ex.git-bridge -
Sätt
GIT_BRIDGE_PORTtill8000 -
Sätt
V1_HISTORY_URLtillhttp://<server-pro sibling container name>:3100/api. Obs: Detta behövs endast på syskoncontainern till git-bridge-containern. De övriga instanserna kan använda en localhost-URL, vilket är standard.
- Sätt
GIT_BRIDGE_API_BASE_URLtillhttp://<server-pro sibling container name>/api/v0, t.ex.http://server-pro-ha-1/api/v0 - Sätt
GIT_BRIDGE_OAUTH2_SERVERtillhttp://<server-pro sibling container name>, t.ex.http://server-pro-ha-1 - Sätt
GIT_BRIDGE_POSTBACK_BASE_URLtillhttp://<git-bridge container name>:8000, t.ex.http://git-bridge:8000 - Sätt
GIT_BRIDGE_ROOT_DIRtill den bind-monterade datadisken för git-bridge, t.ex./data/git-bridge
Exempel på docker-compose.yml-konfiguration
Exempel på docker-compose.yml-konfiguration
Följande konfiguration visar en fristående uppsättning. För att demon ska fungera måste du tillhandahålla en giltig SSL-nyckel/ett giltigt SSL-certifikat och justera
OVERLEAF_SITE_URL. I en riktig uppsättning måste du ersätta platshållarhemligheterna med riktiga hemligheter, enligt kommentarerna i koden. I en riktig uppsättning behöver du också flytta de enskilda containrarna till dedikerade noder och anpassa IP-adresserna till ditt lokala nätverk.Kompileringar körs i TeX Live-containrar bredvid varje Ayakaleaf Pro-instans. Hämta först TeX Live-avbilden på varje Ayakaleaf Pro-värd, till exempel docker pull ghcr.io/ayaka-notes/texlive-full:2026.1.Hårdvara
Vi rekommenderar att du använder samma hårdvaruspecifikationer för alla Ayakaleaf Pro-instanser som ingår i den horisontella skalningen. De allmänna rekommendationerna om hårdvaruspecifikationer för Ayakaleaf Pro-instanser gäller.Uppgradera Ayakaleaf Pro
Som en del av uppgraderingsprocessen kör Ayakaleaf Pro automatiskt databasmigreringar. Dessa migreringar är inte utformade för att köras från flera instanser parallellt. Migreringarna måste slutföras innan själva webbapplikationen startas. Du kan antingen leta efter postenFinished migrations i loggarna eller vänta tills applikationen tar emot trafik.
Uppgraderingsproceduren ser ut så här:
- Planera ett underhållsfönster
- Stoppa alla instanser av Ayakaleaf Pro
- Ta en konsekvent säkerhetskopia enligt beskrivningen i dokumentationen
- Starta en enda instans av Ayakaleaf Pro med den nya versionen
- Kontrollera att den nya instansen fungerar som förväntat
- Starta de övriga instanserna med den nya versionen

