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

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

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 (див. Основні концепції → Система плагінів).

Віджет opt‑in Converter активується за допомогою AddConverterWidget() і доступний через лише для читання властивість ConverterWidget; його параметри задокументовані на сторінці плагіна Converter (Плагіни → Плагін Converter). Віджет 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() валідовує options 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').

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