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

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

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

Вимоги

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

ПлатформаПідтримується
Windows x64 / x86Так
Linux x64, на базі glibc (Debian, Ubuntu, офіційний образ mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim)Так
Alpine та інші дистрибутиви на базі muslНі
macOSНі

У Linux встановіть бібліотеку налаштування шрифтів перед відкриттям першого документа:

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

У RHEL, Fedora та подібних дистрибутивах пакет є fontconfig (dnf install -y fontconfig). Це єдиний системний пакет, який потрібен Doconut: нативні бібліотеки, які він використовує, постачаються всередині пакету NuGet, і libgdiplus не потрібен.
У Docker віддавайте перевагу aspnet:6.0-bookworm-slim (Debian 12): типова мітка aspnet:6.0 — це Debian 11, у якого дзеркала пакетів можуть не вдаватись встановити libfontconfig1. Сторінки рендеряться шрифтами, встановленими на сервері, тому перегляньте Усунення проблем щодо шрифтів та повідомлень про помилки Linux.

Встановити пакет

bash
dotnet add package Doconut.NET6

Команда без зазначення версії встановлює останній стабільний випуск. Щоб зафіксувати випуск, описаний у цій документації, передайте версію як окрему опцію:

bash
dotnet add package Doconut.NET6 --version 26.10.0

Doconut.NET6 — це ідентифікатор пакету. Суфікс версії належить до завантаженого файлу Doconut.NET6.<version>.nupkg і не є частиною ідентифікатора.

Визначте інтеграцію перед оновленням

Ідентифікатор пакету Doconut.NET6 використовувався як у класичній, так і в поточній інтеграції .NET 6. Не обирайте документацію лише за назвою пакету:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), синхронний OpenDocument(...), та вручну скопійовані скрипти переглядача ідентифікують класичну інтеграцію;
  • AddDoconut(), UseDoconutResources(), інжектований Viewer, та OpenDocumentAsync(...) ідентифікують поточну інтеграцію, задокументовану тут.

Перекладений класичний посібник з налаштування все ще доступний. Скористайтеся посібником з міграції, щоб змінити покоління; звичайне оновлення пакету не перетворює запуск, життєвий цикл переглядача чи ресурси браузера автоматично.

Зареєструвати 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‑сесії при запитах сторінок. Вимкнути у продакшн.
MiddlewarePath"/doconut"Значення координації для кінцевої точки page-image. Воно валідовано, але не створює гілку самостійно; тримайте його узгодженим з фактичною мапою UseDoconut() та клієнтським BasePath.
ResourcesPath"/doconut-res"Звідки подаються вбудовані ресурси JS/CSS/зображення.
LicensePath"" (empty string)Шлях до файлу ліцензії. Порожнє означає переходити до наступного джерела, потім автоматичний пошук.
LicenseContent"" (empty string)Необроблений вміст ліцензії — з змінної середовища, менеджера секретів або бази даних.
LicenseStreamnullЛіцензія як потік, зчитується один раз під час запуску.
ResetLicensefalseЗарезервований прапорець сумісності. Поточні сервіси .NET 6 читають ліцензію під час 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;
});

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

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