ForgeDokumentace
cs

Dokumentace

Konfigurace klíčů Total.js 5

Total.js 5 · total5@0.0.19 referenceconfigsettings Spuštěno s Total.js 5

Soubor config má jeden nastavení key : value na řádek a hodnoty jsou k dispozici v globálním objektu CONF (viz recept na konfiguraci pro formát souboru). klíče níže jsou definovány total5 0.0.19 s těmito výchozím; klíč, který není zde a není ve druhém tabulce je váš. Klíče, které začínají s $ jsou nastavení rámu a klíčky secret_ drží tajemství.

Nastavte hodnoty aplikace v konfiguračním souboru a přečtěte si je prostřednictvím CONF. Tabulka uvádí výchozí hodnoty a účel každého nastavení.

KlíčVýchozíPoznámka
name'Total.js'Název aplikace. V pohledu jej vypíše @{'%name'}.
version'1.0.0'Aplikace verze používaná v start-up výstupu, statistiky a výchozí HTTP ETag suffix (index.js).
author''Autor aplikace je zobrazen start-up printem při neúspěchu (index.js).
secretF.syshashAplikace je jasně nastavená v konfiguraci.
secret_encryption''Klíčové čtení šifrovanými trasy WebSocket; to je odlišné od akční šifrované metadata možnost (websocket.js).
secret_totalapi''Fallback token odesílá vestavěný provozovatel TotalAPI (api.js); udržujte server na straně.
secret_csrf''Tajemství tokenů CSRF. Prázdné: kontrola vždy projde.
secret_tms''Token, který musí klienti TMS posílat v hlavičce x-token.
$root''URL předpověď aplikována na trasy a aktivy; také upravuje výchozí endpoint API (routing.js, index.js).
$cors''Názvy hostitelů oddělené čárkou.
$api'/api/'Výchozí koncový bod API.
$sourcemaptrueNastavení metadata nabíjení; LOAD je nastaví z konečného režimu DEBUG nebo je deaktivuje pro selektivní zdroje (index.js).
$httpreqlimit0Limit požadavků na IP.
$httpcompresstrueUmožňuje vyjednávaný gzip pro způsobilé odpovědi; dynamická reakční trasa kontroluje 256-bitový prah (controller.js).
$httpetag''Stačí pro rámcové ETags; když je prázdné, konfigurace to vyplývá z aplikace verze (index.js, controller.js).
$httpmaxsize256KB.
$httprangebuffer51205 MB.
$httptimeout55 sekund.
$httpfilesan objectRozšíření souborů, které jsou slouženy jako statické soubory, jako objekt { extension: true }.
$httpchecktypestruePouze pro data multipart.
$httpmaxage60V sekundách.
$httpmaxkeys33Maximální počet klíčů pro vyhledávání (utils.js); ne omezení pole JSON těla.
$httpmaxkey25Maximální délka klíče pro vyhledávání používaná vyhledávačem (utils.js).
$httpcacheoffset''Např. 1 minute.
$blacklist''HTTP/WebSocket požadavek zpracování testy, zda konfigurovaná hodnota obsahuje IP klienta (http.js, websocket.js).
$xpoweredby'Total.js'Hodnota generovaného název X-Powered-By; prázdný ho potlačuje v kontrolovaných cestách odpovědi (controller.js).
$minifyjstrueMinifikuje poskytované soubory JavaScript.
$minifycsstrueMinifikuje poskytované soubory CSS.
$minifyhtmltrueMinifikuje odesílané HTML.
$port'auto'HTTP sluchátka; auto je vyřešeno na startupu, a Total.run možnosti mohou překonat (index.js).
$ip'0.0.0.0'HTTP poslouchání adresa; Total.run možnosti mohou překonat (index.js).
$unixsocket''Alternativní Unix Socket Listening Path (index.js).Socketové povolení a reverzní nastavení proxy jsou problémy s implementací.
$timezone'utc'Časové pásmo procesu (nastavuje se v process.env.TZ).
$insecurefalseKonfigurace nastaví procesní prostředí pro ověřování TLS z této vlajky (index.js).
$performancefalsePřizpůsobuje HTTP agent maximální socket a socket tuning (index.js); není důkazem rychlosti aplikace.
$filtererrorstrueOdstraňuje odpovídající chyby v souboru chyb (index.js).
$cleartemptrueOvládá odstranění vybraných generovaných/tempových souborů jasnou rutinní (index.js).
$customtitlesfalseKdyž je falešný, generátor metadata zobrazení přidává název aplikace k názvu non-home stránky (viewengine.js).
$clearcache10Interval servisu pro přestavbu interních vyhledávacích/obrazových/templátových/knihových cache (index.js).
$imageconverter'gm'Program, který volá Image: gm, im nebo magick.
$imagememory0Vypnuto, protože např. GM v1.3.32 vyhazuje chybu týkající se paměti.
$statstrueOvládá statistické výstupy / aktualizace odvětví; selektivní LOAD může být deaktivován (index.js).
$npmcache'/var/www/.npm'Npm cache umístění převedené NPMINSTALL pro uid-33 prováděcí odvětví (index.js).
$python'python3'Interpreter příkaz používaný Python provádění a pip pomocníky (index.js); nainstalovat Python odděleně.
$wsmaxsize256KB.
$wscompresstrueUmožňuje vyjednávání WebSocket permessage-deflate na serverových připojeních (websocket.js).
$wsencodedecodefalsePočáteční nastavení kódování serveru WebSocket (websocket.js); ověřte požadovaný formát drátu před změnou.
$wsmaxlatency2000Ping-latence prah v milisekundách používaných spojovacími kontrolami WebSocket (websocket.js).
$proxytimeout55 sekund.
$cookiesamesite'Lax'Podmínkou je politika souborů cookie SameSite, kdy soubor cookie neoznačuje jednu (controller.js).
$cookiesecurefalseDefault Secure cookie přidává, když není poskytován žádný per-cookie override (controller.js).
$csrfexpiration'30 minutes'Jak dlouho je token CSRF platný.
$tapitrueUmožňuje vestavěný provozovatel služby TotalAPI; speciální kontrolní operace překračuje tuto místní bránu (api.js).
$tapiurl'eu'Regionální názvy hostů používá řidič TotalAPI (api.js).
$tapimailfalseVybírejte poštovní cestu TotalAPI, když je funkce TotalAPI aktivována (mail.js).
$tapiloggerfalseUmožňuje protokol TotalAPI, když je nastaven přístup k službě a její tajemství (index.js).
$imprinttrueVyužijte startovací banner (index.js)
$tmsfalseZapne koncový bod WebSocket pro TMS.
$tmsmaxsize256Maximální velikost zprávy TMS v kB.
$tmsurl'/$tms/'URL koncového bodu TMS.
$tmsclearblocked60V minutách.
$total5nastavuje se při startuSložka balíčku total5 (framework z ní čte vlastní soubory).
$nodemodulesnastavuje se při startuSložka, do které NPMINSTALL() instaluje balíčky.
secret_uidSet na začátekTajný vstup použitý krátkou šifrovanou identifikátorovou službou; iniciován ze systémového hashu (index.js, utils.js).
$cryptoivSet na začátekInitializace-vector buffer používaný pomocí šifrování rámu; iniciován na startupu (index.js, utils.js).
$httpexpireSet na začátekBudoucí datum uplynutí UTC HTTP je iniciován a pravidelně aktualizován rámcem (index.js, controller.js).

Tyto klíče nemají výchozí hodnotu. Konfigurují odesílání e-mailů a používají je MAIL() a HTMLMAIL() (viz recept o e-mailu):

KlíčVýznam
mail_smtpAdresa serveru SMTP.
mail_smtp_optionsObjekt se zbývajícími nastaveními připojení: port, user, password, secure...
mail_fromAdresa odesílatele.
mail_from_nameJméno odesílatele.
mail_replyAdresa, která dostává odpovědi, přidaná do každé zprávy.
mail_ccAdresa kopie, přidaná do každé zprávy.
mail_bccAdresa skryté kopie, přidaná do každé zprávy.
controllers/config.js
exports.install = function() {
	ROUTE('GET /config/', config);
};

function config($) {
	$.json({ conf: CONF });
}