DoconutOptions

Konfigurace služeb Doconut

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

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 (viz Core Concepts → Sessions & Security).
stringMiddlewarePath"/doconut"Koordinační hodnota pro endpoint page-image. Je validována, ale nevytváří 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/image/font.
stringLicensePath""Cesta k souboru licence. Prázdná → další zdroj licence, pak automatické vyhledání; nic nenalezeno → vodotiskový evaluační stav bez funkcí.
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 .NET 6 jej nevyužívá; po výměně licence restartujte aplikaci.
DoconutPluginRegistryPluginRegistry—Registr pouze pro čtení sbírající příspěvky pluginů; využívá jej továrna na prohlížeče. Naplňte pomocí AddPlugin<T>().

Priorita licencí (vynucená při registraci služby): LicenseStream → LicenseContent → LicensePath → automatické vyhledání (viz Getting Started → License Setup).

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 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() vyhodí 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 gate (viz Core Concepts → Plugin System).

Widget volitelného Converter je povolen pomocí AddConverterWidget() a je přístupný přes pouze pro čtení vlastnost 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, s AddSignerWidget(), a je přístupný 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án a dokument se otevře bez explicitní konfigurace, použije se ImageConfig.

Vyhodí ArgumentException (Extension must be a non-empty file extension.) při prázdné příponě a ArgumentNullException při null továrně.

Validace při startu

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ř. k 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).

MiddlewarePath není automatický mapovač rout ASP.NET Core. Pokud by Doconut měl 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á?