Настройка лицензии
Где Doconut ищет ваш файл лицензии
Без лицензии Doconut всё равно отображает документы — каждая страница просто содержит водяной знак оценки. На этой странице рассматриваются четыре способа предоставления лицензии и точный порядок приоритета, когда задано более одного.
Четыре способа предоставить лицензию
Существует четыре: три явных источника в DoconutOptions — поток, сырое содержимое или путь к файлу — плюс автоматическое обнаружение, когда ни один из них не задан. Когда задано более одного, порядок приоритета ясен:
LicenseStream побеждает LicenseContent побеждает LicensePath побеждает авто‑поиск.
По пути
LicensePath передаётся в File.Exists точно так, как указано. Относительный путь разрешается относительно текущего рабочего каталога процесса — а не вашей папки проекта и не папки, в которой находится Program.cs. Если путь не разрешается, Doconut не бросает исключение и не переходит к авто‑поиску — он просто не загружает лицензию, и просмотрщик добавляет водяные знаки. Авто‑поиск запускается только когда ни LicensePath, ни LicenseContent, ни LicenseStream не заданы. Файлы лицензий плагинов в той же папке (Doconut.Viewer.<Capability>.lic) читаются вместе с ним, поэтому LicensePath и AddPlugin<...>() работают совместно, когда лицензии плагинов находятся рядом с основной лицензией.
Предпочтительно использовать абсолютный путь (например, построенный из IWebHostEnvironment.WebRootPath или AppContext.BaseDirectory), либо полностью пропустить LicensePath и полагаться на автоматическое обнаружение ниже.
builder.Services.AddDoconut(options =>
{
options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});По потоку
LicenseStream читается один раз при запуске — это полезно, когда лицензия берётся из секретного хранилища, а не из файла на диске.
// Приоритет: LicenseStream > LicenseContent > LicensePath > авто-поиск.
builder.Services.AddDoconut(options =>
{
options.LicenseStream = licenseStream;
});По содержимому
LicenseContent принимает сам текст лицензии — из переменной окружения, базы данных или менеджера секретов:
// XML лицензии из базы данных, переменной окружения или менеджера секретов —
// нет файла на диске. Превзойдён только LicenseStream.
builder.Services.AddDoconut(options =>
{
options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});Автоматическое обнаружение
Не задавайте ни один из трёх явных источников, и Doconut самостоятельно ищет лицензию:
// Ничего не настраивая, Doconut ищет лицензию сам, только в этих двух папках:
// 1. {CurrentDirectory}/wwwroot
// 2. {AppContext.BaseDirectory}/wwwroot (wwwroot внутри папки вывода сборки)
// Сначала ищет Doconut.lic; если его нет, ищет Doconut.Viewer.lic и любые
// per-plugin Doconut.Viewer.<Capability>.lic файлы.
builder.Services.AddDoconut();Папки, в которых производится поиск, в порядке, и имена файлов, которые ищутся:
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 копирует лицензии туда при каждой сборке:
<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, скопированный в корень вывода, никогда не будет найден авто‑поиском. Примеры LicensePath на этой странице указывают на то же место.
Держите файлы
.licвне системы контроля версий — разверните их рядом с приложением или внедрите лицензию черезLicenseContentилиLicenseStreamиз вашего секретного хранилища.
Что происходит без лицензии
Отсутствующая лицензия не бросает. AddDoconut() успешно выполняется, приложение запускается, и просмотрщик работает — но каждая страница содержит водяной знак оценки и ни одна дополнительная возможность не предоставляется.
Файл лицензии, который найден, но отклонён, — это другое дело. Неправильная подпись, вмешательство, занесение в чёрный список или сборка вне диапазона версий лицензии вызывают у OpenDocumentAsync бросок LicenseException с License.RejectionMessage. Истёкшая временная лицензия продолжает работать в режиме с водяным знаком. Платная лицензия, у которой прошла дата подписки, продолжает работать корректно и со всеми своими возможностями во всех сборках, выпущенных до этой даты.
Плагинам нужны возможности
Регистрация плагина без соответствующего разрешения отличается: при отсутствии лицензии, устаревшем файле TRIAL или платной лицензии без этой возможности, AddDoconut() бросает InvalidOperationException, поэтому приложение не запускается. Например, регистрация плагина Converter без лицензии, предоставляющей Converter:
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, чтобы предоставить аутентифицированный диагностический endpoint или управлять флагами функций. Не возвращайте содержимое лицензии или ключи.
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 | Подпись, домен, диапазон версий, чёрный список или проверка плагина во время выполнения отклонили лицензию | Прочитайте сообщение об исключении/отклонении, не раскрывая его недоверенным клиентам |
Следующие шаги
- Лицензирование — возможности, уровни лицензий и проверка того, что было загружено во время выполнения.
- Устранение неполадок — водяные знаки, отклонённые лицензии и ошибки возможностей.
Была ли эта страница полезной?