nopCommerce Dokumentace

Nastavení v souboru appsettings.json

Přehled

Tento článek obsahuje popis souboru appsettings.json. Vysvětlíme v něm, jaká nastavení jsou v tomto souboru k dispozici, k čemu slouží a jak je použít ke změně funkčnosti/chování projektu nopCommerce.

Důležité

Všechna nastavení lze přepsat pomocí proměnných prostředí.

Přehled souboru appsettings.json

Pokud jste již dříve pracovali na projektu ASP.NET Core nebo ASP.NET Core znáte, pravděpodobně jste soubor appsettings.json používali a máte představu o tom, co tento soubor je a k čemu slouží.

Poznámka

Tento soubor můžete upravit také na stránce Konfigurace → Nastavení → Nastavení aplikace (Configuration → Settings → App settings).

Soubor appsettings.json se obecně používá k uložení konfiguračních nastavení aplikace, jako jsou připojovací řetězce k databázi, globální proměnné s rozsahem celé aplikace a mnoho dalších informací. Ve skutečnosti lze v ASP.NET Core konfigurační nastavení aplikace ukládat do různých konfiguračních zdrojů, jako je soubor appsettings.json, soubor appsettings.{EnvironmentName}.json (kde {Environment} je aktuální hostingové prostředí aplikace, například Development, Staging nebo Production), User Secrets (kam se ukládají citlivé informace) atd.

Nastavení dostupná v souboru appsettings.json

DataConfig

Prostřednictvím této sekce se konfiguruje připojení k databázi.

  • ConnectionString Toto nastavení očekává řetězcovou hodnotu.

    Poznámka

    Připojovací řetězec bude mít formát specifický pro zvoleného poskytovatele databáze. Například připojovací řetězec pro SqlServer vypadá takto:

    Data Source={localhost};Initial Catalog={your_data_base_name}};Integrated >Security=False;Persist Security Info=False;User ID={your_user_id}};Password={your_password}};>Trust Server Certificate=True
    
  • DataProvider Můžete zadat jednoho z podporovaných poskytovatelů dat:

  • SQLCommandTimeout Nastavuje dobu čekání (v sekundách) před ukončením pokusu o provedení příkazu a vygenerováním chyby. Ve výchozím stavu není časový limit nastaven a použije se výchozí hodnota aktuálního poskytovatele. Nastavte 0 pro neomezený časový limit.

  • WithNoLock Určuje, zda se má do příkazů SELECT přidávat hint NoLock (týká se pouze SQL Serveru).

AzureBlobConfig

Důležité

Tato sekce nastavení se týká verze 4.80 a starších. Pro nopCommerce verze 4.90 a novější jsou nastavení Azure popsána zde.

K ukládání blob dat můžeme použít Azure Blob Storage. nopCommerce již má tuto funkci integrovanou, stačí jen správně nastavit následující informace. Hodnoty těchto nastavení získáte v Azure při vytváření účtu úložiště.

  • ConnectionString Toto nastavení očekává řetězcovou hodnotu. Zde je třeba zadat připojovací řetězec AzureBlobStorage.
  • ContainerName Hodnota tohoto nastavení je také typu řetězec. V tomto nastavení zadáváme název kontejneru pro Azure BLOB storage.
  • EndPoint Toto nastavení také očekává řetězcovou hodnotu. Zde je třeba nastavit koncový bod (endpoint) pro Azure BLOB storage.
  • AppendContainerName Toto nastavení očekává logickou hodnotu. Nastavte hodnotu na true nebo false podle toho, zda se má při sestavování URL připojit název kontejneru k EndPoint.
  • StoreDataProtectionKeys Toto nastavení očekává logickou hodnotu. Nastavte hodnotu na true, pokud chcete pro Data Protection Keys používat Windows Azure BLOB storage.
  • DataProtectionKeysContainerName Toto nastavení očekává řetězcovou hodnotu. Zde je třeba nastavit název kontejneru Azure pro ukládání Data Protection Keys (tento kontejner by měl být oddělený od kontejneru používaného pro média a měl by být soukromý).
  • DataProtectionKeysVaultId (volitelné) Toto nastavení také očekává řetězcovou hodnotu. Nastavte Azure key vault ID, pokud potřebujete Data Protection Keys šifrovat.

CacheConfig

Konfigurace cache.

  • DefaultCacheTime Toto nastavení určuje dobu životnosti dat v cache. Výchozí hodnota je 60 minut.
  • LinqDisableQueryCache Určuje, zda se má vypnout ukládání LINQ výrazů dotazů do cache. Tato cache zkracuje čas potřebný k parsování dotazů, ale má několik vedlejších účinků. Například výrazy LINQ v cache mohou obsahovat odkazy na externí objekty jako parametry, což může vést k únikům paměti, pokud tyto objekty již jiný kód nepoužívá. Nebo synchronizace přístupu ke cache může způsobit větší latence, než kolik ušetří.

CommonConfig

CommonConfig obsahuje nastavení používaná ke konfiguraci chování samotného nopCommerce. Jde o objekt JSON a obsahuje několik nastavení, jejichž úpravou lze chování nopCommerce změnit.

  • DisplayFullErrorStack Toto nastavení očekává logickou hodnotu. Výchozí hodnota je false. Hodnotu můžete nastavit na true, pokud chcete v produkčním prostředí vidět úplnou chybu. To obvykle nedoporučujeme. Pokud ale máte dobrý důvod zobrazovat úplnou chybu v produkčním prostředí, můžete to provést tímto nastavením. Ve vývojovém prostředí se toto nastavení ignoruje a bez ohledu na nastavenou hodnotu se zobrazí úplná chyba. Lze říci, že ve vývojovém prostředí je toto nastavení vždy zapnuté.

  • UserAgentStringsPath Toto nastavení uchovává cestu k souboru Browscap.xml. Browscap.xml je, jak název souboru napovídá, databáze schopností prohlížečů. V podstatě jde o seznam všech známých prohlížečů a botů spolu s jejich výchozími schopnostmi a omezeními.

    ~/App_Data/browscap.xml
    

    Poznámka

    V informatice je user agent software (softwarový agent), který jedná jménem uživatele, například webový prohlížeč, který „načítá, vykresluje a usnadňuje interakci koncového uživatele s webovým obsahem“. Více informací najdete na stránce UserAgent.

  • CrawlerOnlyUserAgentStringsPath Toto nastavení uchovává umístění/cestu k souboru browscap.crawlersonly.xml. Ukládá user agenty pouze pro „CrawlerOnly“.

    ~/App_Data/browscap.crawlersonly.xml
    
  • CrawlerOnlyAdditionalUserAgentStringsPath Toto nastavení uchovává umístění/cestu k souboru additional.crawlers.xml. Ukládá user agenty pouze pro „crawlery“.

    ~/App_Data/additional.crawlers.xml
    
  • UseSessionStateTempDataProvider Toto nastavení očekává logickou hodnotu. Výchozí hodnota je false. Hodnotu můžete nastavit na true, pokud chcete TempData ukládat do stavu relace (session). Ve výchozím stavu se k ukládání TempData do cookies používá poskytovatel TempData založený na cookies.

  • ScheduleTaskRunTimeout umožňuje nastavit časový limit běhu naplánované úlohy v milisekundách. Nastavte null pro použití výchozí hodnoty.

  • StaticFilesCacheControl určuje hodnotu hlavičky 'Cache-Control' pro statický obsah (v sekundách).

    public,max-age=31536000
    
  • ServeUnknownFileTypes určuje, zda se mají poskytovat soubory, které nemají rozpoznaný typ obsahu. Výchozí hodnota je false.

  • UseAutofac. Hodnota určující, zda se má používat Autofac IoC kontejner. Pokud je vypnuto, použije se výchozí .Net IoC kontejner.

  • PermitLimit. Maximální počet povolení (permit), který lze v okně (1 minuta) povolit. Musí být nastaven na hodnotu > 0 v okamžiku, kdy jsou tyto možnosti předány konstruktoru FixedWindowRateLimiter. Pokud je nastaveno na 0, omezení je vypnuto.

  • QueueCount. Maximální kumulativní počet povolení u požadavků čekajících ve frontě. Musí být nastaven na hodnotu >= 0 v okamžiku, kdy jsou tyto možnosti předány konstruktoru FixedWindowRateLimiter. Pokud je nastaveno na 0, fronta je vypnuta.

  • RejectionStatusCode. Výchozí stavový kód, který se nastaví v odpovědi při odmítnutí požadavku.

DistributedCacheConfig

Distribuovaná cache je cache sdílená více aplikačními servery, obvykle spravovaná jako externí služba vůči aplikačním serverům, které k ní přistupují. Distribuovaná cache může zlepšit výkon a škálovatelnost aplikace ASP.NET Core, zejména pokud je aplikace hostována v cloudové službě nebo na serverové farmě.

  • DistributedCacheType Můžete zvolit jednu z implementací:

    • Memory - Jde o implementaci IDistributedCache poskytovanou frameworkem, která ukládá položky do paměti. Distributed Memory Cache není distribuovaná cache. Položky cache ukládá instance aplikace na serveru, kde aplikace běží.

    • SQL Server - Implementace Distributed SQL Server Cache umožňuje distribuované cache používat jako úložiště databázi SQL Server. K vytvoření tabulky pro položky cache v instanci SQL Serveru můžete použít nástroj SQL-cache. Nástroj vytvoří tabulku se zadaným názvem a schématem. Pro tento účel se doporučuje použít samostatnou databázi.

      dotnet sql-cache create "Data Source=(localdb)\MSSQLLocalDB;Initial Catalog=DistCache;Integrated   Security=True;" dbo nopCache
      
    • Redis - nopCommerce podporuje Redis hned po instalaci. Chcete-li ve své aplikaci povolit Redis, musíte nastavit příslušná nastavení. Více informací o Redis.

    • Redis Synchronized Memory - nopCommerce verze 4.70 přináší nový způsob ukládání do cache se synchronizací prostřednictvím mechanismu zpráv v Redis. Tato možnost má velmi vysoký výkon, protože samotná cache je uložena v paměti a Redis se používá pouze jako synchronizátor. Chcete-li tuto možnost ve své aplikaci povolit, musíte nastavit stejná nastavení jako pro základní cache Redis.

  • Enabled Toto nastavení očekává logickou hodnotu. Nastavte hodnotu na true, pokud chcete povolit Distributed cache. Systém používá cache v paměti (In-Memory), takže toto nastavení určuje, zda se má místo výchozí in-memory caching používat Distributed Cache. Použijte tedy toto nastavení, pokud chcete pro cache používat například Redis.

  • ConnectionString (volitelné) Toto nastavení se používá pouze ve spojení s Redis nebo SQL Server. Očekává řetězcovou hodnotu. Výchozí hodnota tohoto nastavení je

    127.0.0.1:{PORT},ssl=False
    
  • SchemaName (volitelné) Toto nastavení se používá pouze ve spojení se SQL Server.

  • TableName (volitelné) Toto nastavení se používá pouze ve spojení se SQL Server. Název databáze SQL Server.

  • InstanceName (volitelné) Zadejte název instance (ve výchozím stavu „nopCommerce“).

  • PublishIntervalMs (volitelné) Zadejte interval publikování událostí změny klíčů v milisekundách.

HostingConfig

Hosting obsahuje nastavení používaná ke konfiguraci chování hostingu. Jde o objekt JSON a obsahuje několik nastavení, jejichž úpravou lze chování hostingu změnit.

  • UseProxy Toto nastavení očekává logickou hodnotu. Povolte toto nastavení, chcete-li přeposlané hlavičky (forwarded headers) aplikovat na odpovídající pole aktuálního HTTP požadavku.
  • ForwardedProtoHeaderName Toto nastavení očekává řetězcovou hodnotu. Zadejte vlastní název HTTP hlavičky pro identifikaci protokolu (HTTP nebo HTTPS), který klient použil k připojení k vaší proxy nebo load balanceru.
  • ForwardedForHeaderName Toto nastavení očekává řetězcovou hodnotu. Zadejte vlastní název HTTP hlavičky pro určení původní IP adresy (např. CF-Connecting-IP, X-ProxyUser-Ip).
  • KnownProxies Toto nastavení očekává řetězcovou hodnotu. Zadejte seznam IP adres (oddělených čárkou), ze kterých se mají přijímat přeposlané hlavičky.
  • KnownNetworks Toto nastavení očekává řetězcovou hodnotu. Zadejte seznam IP rozsahů v notaci CIDR (oddělených čárkou), ze kterých se mají přijímat přeposlané hlavičky, např. 172.64.0.0/13,162.158.0.0/15

InstallationConfig

Obsahuje nastavení, která se používají ke konfiguraci chování nopCommerce během jeho instalace.

  • DisableSampleData Toto nastavení očekává logickou hodnotu. Určuje, zda může majitel obchodu během instalace nainstalovat ukázková data. Pokud nechcete, aby majitel obchodu během instalace instaloval ukázková data, nastavte hodnotu tohoto nastavení na true.
  • DisabledPlugins Toto nastavení očekává řetězcovou hodnotu. Zadejte seznam pluginů (oddělených čárkou), které se během instalace ignorují.
  • InstallRegionalResources Toto nastavení očekává logickou hodnotu. Umožňuje během instalace vybrat další jazykové zdroje. Volba země určuje nastavení, která budou na obchod aplikována (směnné kurzy, daně, měrné jednotky atd. – regionální specifika).

PluginConfig

  • UseUnsafeLoadAssembly Toto nastavení očekává logickou hodnotu. Hodnotu můžete nastavit na true, pokud chcete načíst sestavení (assembly) do kontextu load-from a obejít tak některé bezpečnostní kontroly.

WebOptimizer

K minifikaci a sdružování (bundling) kódu CSS a JavaScript používáme nástroj WebOptimizer, což je middleware pro ASP.NET Core. Optimalizace se provádí za běhu s cachováním na straně serveru i klienta pro vysoký výkon.

  • EnableJavaScriptBundling Toto nastavení očekává logickou hodnotu. Můžete jej nastavit na true, pokud chcete povolit sdružování a minifikaci JS souborů.
  • EnableCssBundling Toto nastavení očekává logickou hodnotu. Můžete jej nastavit na true, pokud chcete povolit sdružování a minifikaci CSS souborů.
  • JavaScriptBundleSuffix Toto nastavení očekává řetězcovou hodnotu. Můžete nastavit příponu názvu js souboru generovaných balíčků (ve výchozím stavu .scripts).
  • CssBundleSuffix Toto nastavení očekává řetězcovou hodnotu. Můžete nastavit příponu názvu CSS souboru generovaných balíčků (ve výchozím stavu .styles).
  • EnableCaching Toto nastavení očekává logickou hodnotu. Můžete nastavit, zda je povoleno cachování na straně serveru (ve výchozím stavu true).
  • EnableMemoryCache Toto nastavení očekává logickou hodnotu. Můžete nastavit, zda je povoleno cachování založené na Microsoft.Extensions.Caching.Memory.IMemoryCache (ve výchozím stavu true).
  • EnableDiskCache Toto nastavení očekává logickou hodnotu. Určuje, zda se assety pipeline ukládají do cache na disk. To může urychlit restarty aplikace, protože se assety pipeline načtou z disku místo opětovného spuštění pipeline. Ve vývojovém režimu může být užitečné tuto možnost vypnout.
  • EnableTagHelperBundling Toto nastavení očekává logickou hodnotu. Můžete nastavit, zda je sdružování povoleno (ve výchozím stavu false).
  • CdnUrl Toto nastavení očekává řetězcovou hodnotu. Můžete nastavit URL CDN používanou pro TagHelpery (ve výchozím stavu null).
  • CacheDirectory Toto nastavení očekává řetězcovou hodnotu. Nastavuje adresář, do kterého se budou ukládat assety, pokud je EnableDiskCache nastaveno na true (ve výchozím stavu {ContentRootPath}\\wwwroot\\bundles).
  • AllowEmptyBundle Toto nastavení očekává logickou hodnotu. Můžete nastavit, zda je povoleno vygenerovat prázdný balíček místo vyvolání výjimky (ve výchozím stavu true).
  • HttpsCompression Toto nastavení očekává celočíselnou hodnotu. Můžete nastavit, zda se mají soubory komprimovat u HTTPS požadavků, pokud je k dispozici middleware Response Compression. Výchozí hodnota je 2. Můžete zvolit jednu z možností:
    • 1 - Vypne kompresi přes HTTPS.
    • 2 - Zapne kompresi přes HTTPS.

      Poznámka

      Povolení komprese u HTTPS požadavků pro obsah, se kterým lze vzdáleně manipulovat, může způsobit bezpečnostní problémy.

  • MemoryCacheTimeToLive Pokud je povoleno cachování v paměti EnableMemoryCache, určuje, jak dlouho je záznam uložen v paměti. Výchozí hodnota je 60 minut.