DoconutOptions

Konfigurujte služby Doconut

DoconutOptions (namespace Doconut) je jediný konfigurační objekt pro celé SDK. Nastavíte jej jednou, uvnitř AddDoconut(), a je registrován jako singleton.

V předchozí knihovně .NET Standard byl DoconutOptions instance byla vytvořena v čase pipeline a předána UseDoconut(new DoconutOptions { … }). Zde middleware nebere žádné možnosti — vše je nastaveno během registrace služeb.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Vlastnosti

TypVlastnostVýchozíPopis
boolShowDoconutInfofalseKdyž 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; ponechte false v produkci.
boolUnsafeModefalseKdyž true, přeskočí kontrolu zabezpečení ASP.NET-session u požadavků na stránky. Ponechte false v produkci na jediném uzlu (viz Core Concepts → Sessions & Security). Dříve psáno UnSafeMode.
stringMiddlewarePath"/doconut"Koordinační hodnota pro endpoint 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.
stringResourcesPath"/doconut-res"Prefix URL cesty pro vložené zdroje JS/CSS/obrázky/písma.
stringLicensePath""Cesta k souboru licence. Prázdné → další zdroj licence, pak automatické vyhledání; nic nenalezeno → vodotiskový evaluační stav bez schopností.
stringLicenseContent""Surový XML obsah licence (databáze, env var, secret manager). Má přednost před LicensePath.
Stream?LicenseStreamnullLicence jako stream, načtená jednou při startu. Má přednost před oběma ostatními zdroji.
boolResetLicensefalseRezervovaný příznak kompatibility. Aktuální implementace jej nevyužívá; po výměně licence restartujte aplikaci.
DoconutPluginRegistryPluginRegistry—Registr pouze pro čtení shromažďující příspěvky pluginů; využívá ho továrna prohlížečů. Naplňte pomocí AddPlugin<T>().

Priorita licencí (vynucená při registraci služeb): LicenseStream → LicenseContent → LicensePath → automatické vyhledání (viz Začínáme → Nastavení licence).

Metody

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

Použijte tuto metodu pro vydané volitelné balíčky Converter, DICOM a Signer. Anotace a normální 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() vyhodí InvalidOperationException při chybějící licenci, starém souboru TRIAL nebo placené licenci, která neuděluje schopnost pluginu. Registrace dočasných/Demo jsou zachovány po vypršení a podléhají runtime bráně (viz Základní koncepty → Systém pluginů).

Volitelný widget Converter je povolen pomocí AddConverterWidget() a zpřístupněn přes pouze pro čtení vlastnost ConverterWidget; jeho možnosti jsou zdokumentovány na stránce Converter Plugin (Pluginy → Plugin Converter). Volitelný widget Signer je povolen stejným způsobem, pomocí AddSignerWidget(), a zpřístupněn přes pouze pro čtení vlastnost SignerWidget; viz Plugin Signer.

RegisterViewer(extension, factory, defaultConfig?)

text
DoconutOptions RegisterViewer(
    string extension,                    // ".myext" — volitelná úvodní tečka
    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áno a dokument se otevře bez explicitní konfigurace, použije se ImageConfig.

Vyhodí 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() validuje možnosti fail-fast, takže špatná konfigurace se projeví jako jasná výjimka při startu místo matoucích 404 během požadavku:

text
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

csharp
// 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ř. pro vyhnutí se 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 v synchronizaci (viz ViewerConfig). Toto je jedno ze dvou nastavení na straně klienta, které selže bez chybové zprávy.

MiddlewarePath není automatický mapovač rout 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'). Běžná alternativa zachovává historický tvar požadavku DocImage.axd na větvi MapWhen s BasePath: '/'.

Byla tato stránka užitečná?