Налаштування ліцензії

Де Doconut шукає ваш файл ліцензії

Без ліцензії Doconut все одно відображає документи — кожна сторінка лише містить водяний знак оцінки. На цій сторінці розглядаються чотири способи надання ліцензії та точний порядок пріоритету, коли встановлено більше одного.

Чотири способи надання ліцензії

Існує чотири: три явних джерела на DoconutOptions — потік, сирий вміст або шлях до файлу — плюс автоматичне виявлення, коли жодне з них не встановлено. Коли встановлено більше одного, порядок пріоритету є точним:

LicenseStream перевершує LicenseContent перевершує LicensePath перевершує auto-search.

За шляхом

LicensePath передається до File.Exists точно так, як вказано. Відносний шлях розв'язується щодо поточної робочої директорії процесу — а не вашої папки проєкту, і не папки, у якій знаходиться Program.cs. Якщо шлях не розв'язується, Doconut не генерує виключення і не переходить до auto-search — він просто не завантажує ліцензію, і переглядач додає водяний знак. Auto-search виконується лише коли жодне з LicensePath, LicenseContent або LicenseStream не встановлено. Файли ліцензій per-plugin у тій самій папці (Doconut.Viewer.<Capability>.lic) читаються разом з ним, тому LicensePath і AddPlugin<...>() працюють разом, коли ліцензії плагінів розташовані поруч з базовою ліцензією.

Рекомендується використовувати абсолютний шлях (наприклад, сформований з IWebHostEnvironment.WebRootPath або AppContext.BaseDirectory), або повністю пропустити LicensePath і покластися на автоматичне виявлення нижче.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});

За потоком

LicenseStream читається один раз під час запуску — корисно, коли ліцензія надходить із сховища секретів, а не з файлу на диску.

csharp
// Пріоритет: LicenseStream > LicenseContent > LicensePath > автопошук.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

За вмістом

LicenseContent приймає сам текст ліцензії — з змінної середовища, бази даних або менеджера секретів:

csharp
// XML ліцензії з бази даних, змінної середовища або менеджера секретів —
// файлу на диску немає. Переможе лише LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Автоматичне виявлення

Не налаштовуйте жодне з трьох явних джерел, і Doconut сам шукає ліцензію:

csharp
// Нічого не налаштовуйте, і Doconut шукає ліцензію сам, лише у цих двох папках:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot всередині папки вихідних файлів збірки)
// Спочатку шукає Doconut.lic; якщо його немає, Doconut.Viewer.lic плюс будь-які
// файли per-plugin Doconut.Viewer.<Capability>.lic.
builder.Services.AddDoconut();

Папки для пошуку, у порядку, та імена файлів, які шукаються:

text
1. {CurrentDirectory}/wwwroot
2. {AppContext.BaseDirectory}/wwwroot

Filenames, in order (each one looked for in folder 1, then folder 2):
  Doconut.lic                          — legacy all-in-one license; if found, nothing else is read
  Doconut.Viewer.lic                   — base viewer license
  Doconut.Viewer.<Capability>.lic      — per-plugin licenses, read only when Doconut.Viewer.lic was found

Ніщо поза папкою wwwroot не читається: .lic у самій вихідній папці або у wwwroot/lib ігнорується.

Скопіюйте ліцензію у вашу вихідну папку

Коли процес не запускається з папки проєкту — опублікованого застосунку, IIS, контейнера, тестового раннера — перша спроба не знаходить, і друга, {AppContext.BaseDirectory}/wwwroot, повинна знайти файл. Ціль MSBuild копіює ліцензії туди при кожному збірці:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- Спочатку видаліть, щоб перейменування або видалення .lic у wwwroot також вилучало його з вихідних даних. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Призначення має бути $(OutDir)wwwroot: .lic, скопійований у корінь вихідної папки, ніколи не буде знайдений auto-search. Приклади LicensePath на цій сторінці вказують на те саме місце.

Тримайте файли .lic поза системою контролю версій — розгорніть їх поруч із застосунком або впровадьте ліцензію через LicenseContent або LicenseStream з вашого сховища секретів.

Що трапляється без ліцензії

Відсутня ліцензія не викликає виключення. AddDoconut() успішно виконується, застосунок запускається, і переглядач працює — але кожна сторінка має водяний знак оцінки, і жодна додаткова можливість не надається.

Файл ліцензії, який знайдено, але відхилено, інший випадок. Недійсний підпис, підробка, чорний список або збірка поза часовим вікном ліцензії призводять до того, що OpenDocumentAsync викидає LicenseException з License.RejectionMessage. Термінова ліцензія, термін дії якої минув, продовжує працювати у режимі з водяним знаком. Платна ліцензія, у якої дата підписки минула, продовжує працювати, чистою і зі своїми можливостями, у кожній збірці, випущеній до цієї дати.

Плагіни потребують можливостей

Реєстрація плагіна без відповідного права є іншим випадком: при відсутній ліцензії, застарілому файлі TRIAL або платній ліцензії без цієї можливості, AddDoconut() викидає InvalidOperationException, тому застосунок не запускається. Наприклад, реєстрація плагіна Converter без ліцензії, яка надає Converter:

text
InvalidOperationException: The Converter plugin is registered via AddPlugin but no active
license grants Converter. Remove the AddPlugin<...>() call or install a license (or
trial/demo) that includes Converter.

Повідомлення підказує рішення безпосередньо: або видаліть виклик options.AddPlugin<...>() для цього плагіна, або встановіть платну ліцензію чи активну тимчасову/демонстраційну (NFR) ліцензію, яка надає цю можливість. Тимчасові реєстрації дозволено залишатися після закінчення терміну дії, щоб вже налаштований застосунок міг деградувати під час виконання замість аварійного завершення під час перезапуску; після закінчення терміну їх можливості все одно відкликуються.

Перевірте завантажену ліцензію

Використовуйте IDoconutLicenseService, той самий джерело правди, що використовується SDK, щоб надати автентифіковану діагностичну кінцеву точку або керувати прапорцями функцій. Не повертайте вміст ліцензії чи ключі.

csharp
app.MapGet("/api/doconut/license", (IDoconutLicenseService license) => Results.Ok(new
{
    viewer = license.IsViewerLicensed || license.IsTemporary,
    temporary = license.IsTemporary,
    search = license.IsCapabilityGranted(LicenseCapability.Search),
    annotation = license.IsCapabilityGranted(LicenseCapability.Annotation),
    converter = license.HasConverter,
    dicom = license.HasDicom
}));

Ліцензію читають під час реєстрації AddDoconut(). ResetLicense наразі є властивістю сумісності без активного шляху перезавантаження, тому заміна файлу ліцензії вимагає перезапуску застосунку.

Матриця усунення неполадок

СимптомЙмовірна причинаПеревірка
Переглядач працює, але кожна сторінка має водяний знакЛіцензія не була завантажена, або термін дії тимчасової ліцензії минувВирішіть IDoconutLicenseService; перевірте вихідний каталог і робочий каталог процесу
AddDoconut() викидає для плагінаЛіцензія не надає цю можливість плагінуПеревірте IsCapabilityGranted(...) і видаліть реєстрації, які ви не купували
Налаштований відносний шлях працює локально, але не в IIS/контейнеріРобочий каталог процесу змінивсяВикористайте AppContext.BaseDirectory або абсолютний шлях
Замінений файл .lic не має ефектуСервіс ліцензії-одиночка вже був створенийПерезапустіть застосунок
OpenDocumentAsync викидає LicenseExceptionПідпис, домен, часове вікно, чорний список або ворота виконання плагіна відхилили ліцензіюПрочитайте повідомлення про виключення/відхилення, не розкриваючи його недовіреним клієнтам

Наступні кроки

  • Ліцензування — можливості, рівні ліцензій та перевірка того, що завантажено під час виконання.
  • Усунення неполадок — водяні знаки, відхилені ліцензії та помилки можливостей.

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