DoconutOptions
Konfigurace služeb Doconut
DoconutOptions (namespace Doconut) je jediný konfigurační objekt pro celé SDK. Nastavujete jej jednou, uvnitř AddDoconut(), a je registrován jako singleton.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Vlastnosti
| Typ | Vlastnost | Výchozí | Popis |
|---|---|---|---|
bool | ShowDoconutInfo | false | Když true, požadavek middleware bez tokenu vrátí banner verze (Doconut <version> is running on <host>) místo 404. Užitečné jako rychlá kontrola; v produkci ponechte false. |
bool | UnsafeMode | false | Když true, přeskočí kontrolu zabezpečení ASP.NET-sesí na požadavcích stránek. V produkci ponechte false (viz Základní koncepty → Sezení a zabezpečení). |
string | MiddlewarePath | "/doconut" | Koordinační hodnota pro koncový bod page-image. Je validována, ale nenavazuje větev pipeline; udržujte ji v souladu se skutečným mapováním UseDoconut() a klientským BasePath. |
string | ResourcesPath | "/doconut-res" | Prefix URL cesty pro vložené zdroje JS/CSS/obrázek/písmo. |
string | LicensePath | "" | Cesta k souboru licence. Prázdné → další zdroj licence, pak automatické vyhledání; nic nenalezeno → vodotiskový evaluační stav bez funkcí. |
string | LicenseContent | "" | Surový XML obsah licence (databáze, env var, secret manager). Má přednost před LicensePath. |
Stream? | LicenseStream | null | Licence jako stream, načtená jednou při startu. Má přednost před oběma ostatními zdroji. |
bool | ResetLicense | false | Rezervovaný kompatibilní příznak. Současná implementace .NET 8 jej nevyužívá; po výměně licence restartujte aplikaci. |
DoconutPluginRegistry | PluginRegistry | — | Registr pouze pro čtení shromažďující příspěvky pluginů; používá jej továrna prohlížeče. Naplňte pomocí AddPlugin<T>(). |
Priorita licencí (vynucená při registraci služby): LicenseStream → LicenseContent → LicensePath → automatické vyhledání (viz Začínáme → Nastavení licence).
Metody
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Použijte tuto metodu pro vydané volitelné balíčky Converter, DICOM a Signer. Anotace a běžné vyhledávání jsou vestavěné licencované funkce a nepoužívají AddPlugin<TPlugin>().
Registruje plugin první strany (Converter, DICOM, Signer). Fluent — vrací instanci možností. AddDoconut() vyhazuje InvalidOperationException při chybějící licenci, starém souboru TRIAL nebo placené licenci, která neposkytuje schopnost pluginu. Dočasné/Demo registrace jsou zachovány po vypršení a podléhají runtime bráně (viz Základní koncepty → Systém pluginů).
Widget volitelného Converter je povolen pomocí AddConverterWidget() a zpřístupněn přes vlastnost pouze pro čtení ConverterWidget; jeho možnosti jsou zdokumentovány na stránce Converter Plugin (Plugins → Converter Plugin). Widget volitelného Signer je povolen stejným způsobem, pomocí AddSignerWidget(), a zpřístupněn přes vlastnost pouze pro čtení SignerWidget; viz Plugin Signer.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — úvodní tečka volitelná
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Registruje vlastní prohlížeč pro příponu souboru. Vlastní prohlížeče mají přednost před vestavěnými a pluginovými prohlížeči a nejsou omezeny licencí. Když je defaultConfig vynechán a dokument se otevře bez explicitní konfigurace, použije se ImageConfig.
Vyhazuje ArgumentException (Extension must be a non-empty file extension.) pro prázdnou příponu a ArgumentNullException pro nulovou továrnu.
Validace při spuštění
AddDoconut() ověřuje možnosti fail-fast, takže špatná konfigurace se projeví jako jasná výjimka při spuštění místo matoucích 404 během požadavku:
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.Běžné konfigurace
// Produkce: explicitní licence, vše uzamčeno (všechny výchozí bezpečnostní nastavení)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// Vlastní cesty (např. aby se předešlo konfliktu trasy)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});Když změníte ResourcesPath, udržujte ResPath klientského widgetu synchronizované (viz ViewerConfig).
MiddlewarePath není automatický mapovač tras ASP.NET Core. Pokud má Doconut odpovídat pouze pod vlastním prefixem, připojte UseDoconut() na tuto větev (například pomocí app.Map("/docs-engine", branch => branch.UseDoconut())) a nastavte klientské BasePath na tento prefix bez úvodního / ('docs-engine').
Byla tato stránka užitečná?