Встановлення

Додайте Doconut до вашого проєкту .NET 8

Базовий переглядач Doconut для .NET 8 постачається як один пакет NuGet, який підключається до будь‑якого застосунку ASP.NET Core. Додаткові плагіни використовують окремі пакети. На цій сторінці встановлюється базовий пакет і реєструється проміжне ПЗ — мінімум, необхідний перед вашим першим рендерингом.

Вимоги

Пакет працює на таких платформах:

ПлатформаПідтримується
Windows x64 / x86Так
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:8.0 image)Так
Alpine and other musl-based distributionsНі
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.

Два виклики проміжного ПЗ завершують налаштування, і їх порядок має значення: UseDoconutResources() має виконуватись перед UseDoconut(). UseDoconut() — це термінальний проміжний ПЗ, тому його виклик першим означає, що кожен запит до ресурсу /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;
});

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

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