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

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

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

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

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

LicenseStream перевершує LicenseContent перевершує LicensePath перевершує автоматичне виявлення.

За шляхом

Надайте LicensePath повний шлях. Відносний шлях розв'язується щодо поточної директорії процесу, і під IIS це папка самого робочого процесу, а не ваш сайт. HostingEnvironment.MapPath перетворює шлях відносно сайту у повний:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});

Якщо файл не існує, Doconut не генерує виключення і не переходить до автоматичного виявлення: він не завантажує жодної ліцензії, і переглядач додає водяний знак. Файли ліцензій для кожного плагіна у тій самій папці (Doconut.Viewer.<Capability>.lic) читаються разом з нею, тому LicensePath і AddPlugin<...>() працюють разом, коли ліцензії плагінів розташовані поруч із базовою ліцензією.

За потоком

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

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

За вмістом

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

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

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

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

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

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

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

Під IIS та IIS Express, AppContext.BaseDirectory є кореневою папкою сайту — тією, що містить Web.config — а не її папкою bin. Тому ліцензія повинна знаходитися у wwwroot під коренем сайту:

text
MySite\
  Web.config
  Global.asax
  bin\
  wwwroot\
    Doconut.Viewer.lic
    Doconut.Viewer.Converter.lic

У проєкті тримайте wwwroot\*.lic поруч із Web.config і розгорніть папку разом із сайтом. Не потрібно копіювати її в жодному кроці збірки. .lic в будь-якому іншому місці — у bin\, поруч із Web.config, або у підпапці wwwroot — ніколи не читається.

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

Що відбувається без ліцензії

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

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

Плагіни потребують свою ліцензію під час запуску

Реєстрація плагіна, можливість якого не надає жодна ліцензія, зупиняє застосунок під час запуску. DoconutHost.Initialize викидає у Application_Start:

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.

У System.Web ви не бачите це повідомлення у браузері. Кожен запит до сайту відповідає порожнім 500 — без сторінки помилки, без трасування стеку, нічого у журналі IIS. Виключення записується лише у Windows event log (журнал Application, джерело ASP.NET). Якщо весь сайт перестає відповідати одразу після додавання рядка AddPlugin, перевірте файли ліцензій у wwwroot перед кодом: Doconut.Viewer.<Capability>.lic плагіна має знаходитися поруч із Doconut.Viewer.lic, і без базової ліцензії файли плагіна взагалі не читаються.

Перевірка завантаженої ліцензії

IDoconutLicenseService — це той самий джерело правди, який використовує SDK. Отримайте його з DoconutHost.Services, щоб відкрити автентифіковану діагностичну кінцеву точку або керувати прапорцями функцій — ніколи не повертайте вміст ліцензії:

csharp
// GET /License/Status
public ActionResult Status()
{
    var license = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(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
    }, JsonRequestBehavior.AllowGet);
}

Ліцензію читають один раз, у DoconutHost.Initialize. Після заміни файлу ліцензії перезапустіть пул застосунків (або змініть Web.config), щоб Application_Start запустився знову.

Усунення неполадок

СимптомЙмовірна причинаПеревірка
Переглядач працює, але кожна сторінка має водяний знакЛіцензію не знайденоЧи знаходиться .lic у <site root>\wwwroot? Викличте кінцеву точку статусу вище
Кожен запит відповідає порожнім 500 одразу після додавання плагінаЗареєстрований плагін не має ліцензії, що його надаєЖурнал Windows event log, джерело ASP.NET; .lic плагіна поруч із Doconut.Viewer.lic
LicensePath працює на вашій машині, але не на серверіВідносний шлях, що розв'язується від папки процесу робітникаЗбирайте його за допомогою HostingEnvironment.MapPath("~/wwwroot/...")
Замінений файл .lic не має ефектуЛіцензію було прочитано під час запуску застосункуПерезапустіть пул застосунків
OpenDocumentAsync викидає LicenseExceptionЛіцензію знайдено, але відхиленоПрочитайте повідомлення виключення; не показуйте його недовіреним клієнтам

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

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