Установка

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

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

Требования

Пакет работает на следующих платформах:

ПлатформаПоддерживается
Windows x64 / x86Да
Linux x64, на основе glibc (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:8.0 image)Да
Alpine и другие дистрибутивы на основе muslНет
macOSНет

В Linux установите библиотеку конфигурации шрифтов перед открытием первого документа:

bash
apt-get update && apt-get install -y libfontconfig1

В RHEL, Fedora и похожих дистрибутивах пакет является fontconfig (dnf install -y fontconfig). Это единственный системный пакет, который нужен Doconut: нативные библиотеки, которые он использует, поставляются внутри пакета NuGet, а libgdiplus не требуется. Страницы отрисовываются шрифтами, установленными на сервере, поэтому смотрите Устранение неполадок для шрифтов и сообщений об ошибках Linux.

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

bash
dotnet add package Doconut.NET8

Команда без указания версии устанавливает последнюю стабильную версию. Чтобы зафиксировать релиз, описанный в этой документации, передайте версию как отдельный параметр:

bash
dotnet add package Doconut.NET8 --version 26.10.0

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

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

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

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

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // состоянию сессии нужен кэш (MVC/Razor Pages уже добавляют его)
builder.Services.AddSession(); // Безопасность документов Doconut опирается на состояние сессии ASP.NET

app.UseSession();          // вызовите UseSession() перед UseDoconut()
app.UseDoconutResources(); // должно быть зарегистрировано перед UseDoconut()
app.Map("/doconut", branch => branch.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(); перезапустите приложение после замены лицензии.
MaxConcurrentEditorSessions200Максимальное количество активных сессий редактора (документы, открытые с помощью DocOptions.EditMode). При превышении закрывается самая давно неиспользуемая простаивающая сессия редактора. Обычные сессии просмотрщика не учитываются. 0 или отрицательное значение означают отсутствие ограничения.
EditorSnapshotEveryOps50При включённой постоянстве редактора (AddDoconutEditorPersistence) делайте снимок живого документа каждые N зафиксированных изменений. 0 или отрицательное значение никогда не делают снимки в середине сессии. Не влияет, когда постоянство отключено.

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

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // координируйте с отображением приложения и клиентским BasePath
    options.ResourcesPath   = "/doconut-res"; // откуда обслуживаются JS/CSS/изображения просмотрщика
    options.UnsafeMode      = false;          // поддерживайте включённую безопасность сессии
    options.ShowDoconutInfo = false;
});

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

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