Dokumentáció futtatása MailGen nélkül

Architecture-checkout és futó Docker segítségével olvasd el a setupot a teljes alkalmazás nélkül. Nincs szükséged gyökér .env fájlra, host Node.js/Python környezetre, Kafkára, adatbázisra, megosztott proxyra vagy alkalmazás-setupra. Linuxon és macOS-en Bash-t használj. macOS-en indítsd el a Docker Desktopot, Linuxon szerezz Docker Engine-hozzáférést.

Dokumentációs mód kiválasztása

Mód	Hely és parancs	Cím	Leállítás hatóköre
Eldobható helyi statikus dokumentáció	Architecture vagy motherrepo: bash docsStarter.sh	A kiírt localhost URL és szabad port	A Ctrl+C csak a saját docs-konténert távolítja el
Egységes MailGen-dokumentáció	Motherrepo szokásos életciklusa	A konfigurált megosztott proxy docs-host, jellemzően https://docs.INSTANCE.ecas.local:8443/	A gyökér leállítás a teljes alkalmazás-stacket érinti
Régebbi Architecture Compose	Architecture/docker-compose.yml	Host 5700, belső 3000, az MCP külön 3456	Külön Compose-projekt
Önálló Coolify-dokumentáció	Architecture/compose.coolify.yaml	Az operátor nyilvános HTTPS docs-domainje	Csak a külön docs-erőforrás

A dokumentáció címe nem Account-bejelentkezés, BFF vagy szolgáltatói callback. Az alkalmazáshoz használd az első setupot.

Eldobható helyi dokumentáció

bash docsStarter.sh

A motherrepo-wrapper az Architecture-szkriptet hívja. Az abszolút szkriptútvonal is működik. Ellenőrzi a Docker és a forrás elérhetőségét, statikus oldalt épít, és kiír egy olvasható setup-URL-t.

Ha az Architecture hiányzik, szerezz repository-hozzáférést, és csak ezt a submodule-t inicializáld a motherrepo gyökeréből:

git submodule update --init -- Architecture
bash docsStarter.sh

Csak a dokumentáció olvasásához nincs szükség gyökér .env fájlra vagy 0daysetup.sh-ra. A GitHub-letöltési útmutató leírja a repository-hozzáférést.

A Docker közvetlenül szabad host-portot foglal, csak a 127.0.0.1 címhez kötve. Az Nginx a statikus kimenetet 64 MiB, 0.5 CPU és 64 folyamat korláttal szolgálja ki. Ebben a kiszolgáló-konténerben nem fut Node fejlesztőszerver. Nincs állandó volume-ja.

Az első build internet-hozzáférést és több GiB szabad memóriát/lemezt igényel. A Node heap-korlát 2 GiB. A teljes build-memória meghaladhatja ezt a heapet. A 64 MiB-os kiszolgálási korlát nem a build-kapacitást írja le. A változatlan forrás újrahasználhatja a build cache-t.

A Ctrl+C eltávolítja ezt a konténert, de nem változtatja meg a MailGen-adatokat, hálózatokat, volume-okat vagy titkokat. Az image- és build cache megmarad. Host-leállítás vagy kill -9 nem tudja lefuttatni a szkript cleanup trapjét. Egy megmaradt eldobható konténer külön leállítható, és a --rm miatt magától törlődik.

Ez a mód statikus. Markdown-változás után építsd újra. Nem figyeli a forrásfájlokat. Az indító jelenleg a régi setup-útvonalat írja ki, a weboldal kezdőgombja pedig az eredeti nyelvű fát is megnyithatja. Angol nyelvhez tartsd meg a kiírt originet és portot, majd nyisd meg a /docs/en/Installation/first-install/ útvonalat. Például a http://127.0.0.1:49152 kiírt origin esetén nyisd meg a http://127.0.0.1:49152/docs/en/Installation/first-install/ címet.

Az angol dokumentáció kezdőlapja a /docs/en/intro, például http://127.0.0.1:49152/docs/en/intro. A példaport helyett írd be a ténylegesen kiírt portot. A dokumentációs navigációban válaszd az English nyelvet, az újonnan érkezők sorrendjéhez pedig a Start here részt. Az oldal alapértelmezett belépési pontja maradhat magyar. Ezek a közvetlen angol útvonalak kifejezetten kiválasztják a nyelvet. Az aktuális indító nem választja ki őket automatikusan.

Csak a dokumentáció deployolása Coolifyban

Csak az Architecture repositoryt használd. Adj a Coolifynak csak olvasható Git-forrást a privát repositoryhoz.

1. Hozz létre Application-erőforrást a kívánt Projectben/Environmentben, és válaszd ki az Architecture repositoryt és branchet.
2. Válaszd a Docker Compose lehetőséget, a Base Directory mezőbe /-t, a Compose Location mezőbe /compose.coolify.yaml értéket írj, majd mentsd.
3. A Services → docs → Domains részben add meg a HTTPS-domaint. Irányítsd a belső szolgáltatásportra: 80.
4. Állítsd a DNS A/AAAA rekordjait a kívánt szerverre, és tedd elérhetővé a proxy 80/443 portjait.
5. Állítsd a DOCUSAURUS_PUBLIC_URL értékét a nyilvános originre, majd deployold.

Ha a Coolify domain-jelöléssel kéri a célportot, a :80 utótag választja ki a belső célt. A böngésző továbbra is nyilvános HTTPS-t használ. A DOCUSAURUS_PUBLIC_URL értékébe ne írd bele ezt a routing-utótagot vagy a /docs részt.

A Dockerfile.docs felépíti a statikus oldalt, és Nginx-szel szolgálja ki. A külön Compose-fájl nem tesz közzé host-portot, és nem rögzít konténernevet, külső hálózatot vagy proxy-címkéket. A routingot a Coolify kezeli. Nem szükséges hozzá a MailGen NPM-proxyja.

Változó	Jelentés	Alapértelmezett	Mikor kell
DOCUSAURUS_PUBLIC_URL	A nyilvános origin a kanonikus/sitemap URL-ekhez, útvonal nélkül	http://localhost	Nyilvános domainhez add meg. Build-argumentum, nem futásidejű titok.

A sablonhoz használd az Environment Variables → Developer view nézetet és a csak dokumentációhoz tartozó .env.coolify.example fájlt. Ez nem a MailGen gyökérkonfigurációja. Az URL módosításához új build/deploy kell.

Nyisd meg a nyilvános domaint, és ellenőrizd a docs healthcheckjét. Domain-hiba esetén a DNS-t, a szolgáltatás készenlétét, a célportos routingot és a tanúsítványt kell ellenőrizni. Nem igényel MailGen-adatresetet.

Egyedi környezeti fájl

Az Architecture könyvtárból a kézi build kifejezetten kiválaszthat egy csak dokumentációhoz tartozó fájlt:

docker compose --env-file /YOUR/PATH/docs.env -f compose.coolify.yaml build docs

Csak a nyilvános docs URL kell. Másképp elnevezett env-fájl nem töltődik be automatikusan. Ez build-argumentum, nem env_file: futásidejű csatolás. Az eldobható indító szándékosan nem olvas env-fájlt.

Környezetmentes statikus konfigurációellenőrzés:

docker compose --env-file /dev/null -f compose.coolify.yaml config

Az alkalmazás elhelyezésének külön kezelése

A gyökér ECS_DEPLOYMENT_MODE és ECS_REMOTE_SIMULATION az alkalmazás-infrastruktúra elhelyezését választják ki. Nem módosítják a docsStartert, és a docs-erőforráson keresztül nem provisionálják a Kafkát, a ClamAV-ot, a Collabora-t, a Tikát vagy a Qdrantot.

Egy egészséges távoli dokumentációs oldal nem igazolja az Office callback-hozzáférést, a Kafka-identitás- és állapotátvitelt vagy a scanner készenlétét. Ezekhez az előfeltételekhez használd a részleges távoli deploymentet.

Ha az oldal nem nyílik meg

Tünet	Következő lépés
A Docker nem érhető el	Indítsd el a Dockert, ellenőrizd a felhasználód Docker-hozzáférését, majd próbáld újra az indítót.
A terminál még épít	Várd meg a végső URL-t. A kiszolgálási és a build-memóriakorlát eltér.
A régi localhost-könyvjelző nem működik	Használd az újonnan kiírt szabad portot.
A Coolify-domain offline	Ellenőrizd a DNS-t, a szolgáltatás állapotát, a belső 80-as portos routingot és a tanúsítványt.
A szerkesztett Markdown nem látszik	Építsd újra és deployold az önálló statikus image-et. Az egységes production-dokumentációhoz production docs build is kell. Az egységes fejlesztési npm start figyeli a forrást.

A csak dokumentációs erőforrás igénye nem írja le a teljes MailGen-kapacitást.