Установка

Добавьте Doconut в ваш проект .NET 8

Базовый просмотрщик Doconut для .NET 8 поставляется в виде одного пакета NuGet, который подключается к любому приложению ASP.NET Core. Дополнительные плагины используют отдельные пакеты. На этой странице устанавливается базовый пакет и регистрируется middleware — минимум, необходимый перед первым рендерингом.

Установить пакет

bash
dotnet add package Doconut.NET8

Команда без указания версии устанавливает последнюю стабильную версию. Чтобы точно воспроизвести текущий релиз 26.7.0, укажите версию как отдельный параметр:

bash
dotnet add package Doconut.NET8 --version 26.7.0

Doconut.NET8 — это идентификатор пакета. Суффикс .26.7.0 относится к имени загруженного файла Doconut.NET8.26.7.0.nupkg и не является частью идентификатора.

Зарегистрировать Doconut

AddDoconut() — единственная точка входа для регистрации; существует единственная перегрузка, и она подключает сервис Viewer, сервис лицензий и инфраструктуру рендеринга в контейнер DI.

Два вызова middleware завершают настройку, и их порядок имеет значение: UseDoconutResources() должен выполняться до UseDoconut(). UseDoconut() — терминальный middleware, поэтому вызов его первым приводит к тому, что каждый запрос к ресурсу /doconut-res никогда не достигает обработчика ресурсов и получает 404. Также требуется настройка сессии — стандартная защита документов Doconut проверяет каждый запрос страницы против состояния сессии ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddSession(); // Doconut document security rides on ASP.NET session state

app.UseSession();          // call UseSession() before UseDoconut()
app.UseDoconutResources(); // must be registered before UseDoconut()
app.UseDoconut();

Все параметры

DoconutOptions принимает следующие настраиваемые свойства. Каждое из них является необязательным — ниже указаны значения по умолчанию, которые применяются, если свойство не задано.

СвойствоПо умолчаниюОписание
ShowDoconutInfofalseКогда true, запрос без token возвращает баннер с версией вместо 404. Полезно для быстрой проверки; отключайте в продакшене.
UnsafeModefalseКогда true, пропускает проверку безопасности ASP.NET‑session при запросах страниц. Отключайте в продакшене.
MiddlewarePath"/doconut"Координационное значение для конечной точки page‑image. Оно проверяется, но само по себе не монтирует ветку; держите его согласованным с реальным сопоставлением UseDoconut() и клиентским BasePath.
ResourcesPath"/doconut-res"Откуда обслуживаются встроенные ресурсы JS/CSS/изображения.
LicensePath"" (empty string)Путь к файлу лицензии. Пустое значение означает переход к следующему источнику, затем авто‑поиск.
LicenseContent"" (empty string)Сырой контент лицензии — из переменной окружения, менеджера секретов или базы данных.
LicenseStreamnullЛицензия в виде потока, читается один раз при запуске.
ResetLicensefalseРезервный флаг совместимости. Текущие сервисы .NET 8 читают лицензию во время AddDoconut(); перезапустите приложение после замены лицензии.

Приоритет лицензий, когда задано более одного источника: LicenseStream превалирует над LicenseContent, который превалирует над LicensePath, который превалирует над авто‑поиском — см. License Setup.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // coordinate with app mapping and client BasePath
    options.ResourcesPath   = "/doconut-res"; // where the viewer's JS/CSS/images are served from
    options.UnsafeMode      = false;          // keep session security on
    options.ShowDoconutInfo = false;
});

Следующие шаги

  • Quick Start — откройте ваш первый документ и отобразите его в браузере.
  • License Setup — где Doconut ищет ваш файл лицензии.

Была ли эта страница полезной?