DoconutOptions

Налаштування сервісів Doconut

DoconutOptions (namespace Doconut) — це єдиний об’єкт конфігурації для всього SDK. Ви налаштовуєте його один раз, всередині AddDoconut(), і він реєструється як singleton.

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

Properties

ТипВластивістьЗа замовчуваннямОпис
boolShowDoconutInfofalseКоли true, запит проміжного програмного забезпечення без токену повертає банер версії (Doconut <version> is running on <host>) замість 404. Корисно для швидкої перевірки; залиште false у продакшн.
boolUnsafeModefalseКоли true, пропускає перевірку безпеки ASP.NET‑session при запитах сторінок. Залиште false у продакшн (див. Core Concepts → Sessions & Security).
stringMiddlewarePath"/doconut"Значення координації для кінцевої точки page-image. Воно перевіряється, але не монтує гілку конвеєра; тримайте його синхронізованим з фактичною мапою UseDoconut() та клієнтським BasePath.
stringResourcesPath"/doconut-res"Префікс URL‑шляху для вбудованих ресурсів JS/CSS/зображень/шрифтів.
stringLicensePath""Шлях до файлу ліцензії. Порожньо → наступне джерело ліцензії, потім автоматичне виявлення; якщо нічого не знайдено → стан оцінки з водяним знаком без можливостей.
stringLicenseContent""Необроблений XML‑вміст ліцензії (база даних, змінна середовища, менеджер секретів). Має пріоритет над LicensePath.
Stream?LicenseStreamnullЛіцензія у вигляді потоку, читається один раз під час запуску. Має пріоритет над обома іншими джерелами.
boolResetLicensefalseЗарезервований прапорець сумісності. Поточна реалізація .NET 8 його не використовує; перезапустіть застосунок після заміни ліцензії.
DoconutPluginRegistryPluginRegistry—Реєстр лише для читання, що збирає внески плагінів; використовується фабрикою переглядачів. Заповнюйте через AddPlugin<T>().

Пріоритет ліцензій (застосовується під час реєстрації сервісу): LicenseStream → LicenseContent → LicensePath → автоматичне виявлення (див. Getting Started → License Setup).

Methods

AddPlugin<TPlugin>()

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

Використовуйте цей метод для випущених opt‑in пакетів Converter, DICOM та Signer. Анотація та звичайний пошук — це вбудовані ліцензовані функції і не використовують AddPlugin<TPlugin>().

Реєструє плагін першої сторони (Converter, DICOM, Signer). Fluent — повертає екземпляр options. AddDoconut() генерує InvalidOperationException у випадку відсутньої ліцензії, застарілого файлу TRIAL або платної ліцензії, що не надає можливості плагіну. Тимчасові/демо‑реєстрації зберігаються після закінчення терміну дії та підлягають runtime‑gate (див. Core Concepts → Plugin System).

Віджет opt‑in Converter активується за допомогою AddConverterWidget() і доступний через лише для читання властивість ConverterWidget; його параметри задокументовані на сторінці плагіну Converter (Plugins → Converter Plugin). Віджет opt‑in Signer активується аналогічно, за допомогою AddSignerWidget(), і доступний через лише для читання властивість SignerWidget; див. Плагін Signer.

RegisterViewer(extension, factory, defaultConfig?)

text
DoconutOptions RegisterViewer(
    string extension,                    // ".myext" — ведуча крапка необов'язкова
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

Реєструє користувацький переглядач для розширення файлу. Користувацькі переглядачі мають пріоритет над вбудованими та переглядачами плагінів і не залежать від ліцензії. Якщо defaultConfig пропущено і документ відкривається без явної конфігурації, використовується ImageConfig.

Викидає ArgumentException (Extension must be a non-empty file extension.) для порожнього розширення та ArgumentNullException для null‑factory.

Startup validation

AddDoconut() перевіряє параметри fail-fast, тому помилкова конфігурація проявляється як чітке виключення під час запуску, а не як заплутані 404 під час запиту:

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.

Common configurations

csharp
// Production: явна ліцензія, все заблоковано (всі типові налаштування безпеки)
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});

// Користувацькі шляхи (наприклад, щоб уникнути конфлікту маршруту)
builder.Services.AddDoconut(options =>
{
    options.MiddlewarePath = "/docs-engine";
    options.ResourcesPath  = "/docs-assets";
});

Коли ви змінюєте ResourcesPath, підтримуйте синхронізацію ResPath клієнтського віджету (див. ViewerConfig).

MiddlewarePath не є автоматичним мапером маршрутів ASP.NET Core. Якщо Doconut має відповідати лише під кастомним префіксом, змонтуйте UseDoconut() на цій гілці (наприклад за допомогою app.Map("/docs-engine", branch => branch.UseDoconut())) і встановіть клієнтське BasePath на цей префікс без початкового / ('docs-engine').

Чи була ця сторінка корисною?