Установка
Добавьте Doconut в ваш проект .NET 6
Базовый просмотрщик Doconut для .NET 6 поставляется в виде одного пакета NuGet, который подключается к любому приложению ASP.NET Core. Дополнительные плагины используют отдельные пакеты. Эта страница устанавливает базовый пакет и регистрирует middleware — минимум, необходимый перед первым рендером.
Требования
Пакет работает на следующих платформах:
| Платформа | Поддержка |
|---|---|
| Windows x64 / x86 | Да |
Linux x64, основанный на glibc (Debian, Ubuntu, официальный mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim образ) | Да |
| Alpine и другие дистрибутивы на основе musl | Нет |
| macOS | Нет |
В Linux установите библиотеку конфигурации шрифтов перед открытием первого документа:
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.
Установить пакет
dotnet add package Doconut.NET6Команда без указания версии устанавливает последнюю стабильную версию. Чтобы зафиксировать релиз, описанный в этой документации, передайте версию как отдельный параметр:
dotnet add package Doconut.NET6 --version 26.10.0Doconut.NET6 — это идентификатор пакета. Суффикс версии относится к загруженному файлу Doconut.NET6.<version>.nupkg и не является частью идентификатора.
Определите интеграцию перед обновлением
Идентификатор пакета Doconut.NET6 использовался как в классической, так и в текущей интеграции .NET 6. Не выбирайте документацию только по названию пакета:
DocImage.axd,new Viewer(_cache, _accessor, ...), синхронныйOpenDocument(...)и вручную скопированные скрипты просмотрщика определяют классическую интеграцию;AddDoconut(),UseDoconutResources(), внедренныйViewerиOpenDocumentAsync(...)определяют текущую интеграцию, описанную здесь.
Переведённый классический руководствo по настройке по‑прежнему доступен. Используйте руководство по миграции, чтобы изменить поколение; обычное обновление пакета не преобразует запуск, время жизни просмотрщика или ресурсы браузера автоматически.
Зарегистрировать Doconut
AddDoconut() — единственная точка входа регистрации; существует единственная перегрузка, и она подключает сервис Viewer, сервис лицензий и инфраструктуру рендеринга в контейнер DI.
Два вызова middleware завершают настройку, и их порядок важен: UseDoconutResources() должен выполняться до UseDoconut(). UseDoconut() является конечным middleware, поэтому вызов его первым приводит к тому, что каждый запрос к ресурсу /doconut-res никогда не достигает обработчика ресурсов и получает 404. UseDoconut() отвечает на каждый запрос, который до него доходит, поэтому монтируйте его в отдельной ветке с помощью app.Map. Подключение сессии также требуется — стандартная защита документов Doconut проверяет каждый запрос страницы против состояния сессии ASP.NET.
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 принимает следующие настраиваемые свойства. Каждое из них является необязательным — ниже указаны значения по умолчанию, которые применяются, если свойство не задано.
| Свойство | По умолчанию | Описание |
|---|---|---|
ShowDoconutInfo | false | Когда true, запрос без token возвращает баннер версии вместо 404. Полезно как проверка; отключайте в продакшене. |
UnsafeMode | false | Когда true, пропускает проверку безопасности ASP.NET‑session при запросах страниц. Отключайте в продакшене. |
MiddlewarePath | "/doconut" | Координационное значение для конечной точки page-image. Оно проверяется, но само по себе не монтирует ветку; держите его согласованным с реальным сопоставлением UseDoconut() и клиентским BasePath. |
ResourcesPath | "/doconut-res" | Откуда обслуживаются встроенные ресурсы JS/CSS/изображения. |
LicensePath | "" (empty string) | Путь к файлу лицензии. Пустая строка означает переход к следующему источнику, затем авто‑поиск. |
LicenseContent | "" (empty string) | Сырой контент лицензии — из переменной окружения, менеджера секретов или базы данных. |
LicenseStream | null | Лицензия как поток, читается один раз при запуске. |
ResetLicense | false | Зарезервированный флаг совместимости. Текущие сервисы .NET 6 читают лицензию во время AddDoconut(); перезапустите приложение после замены лицензии. |
MaxConcurrentEditorSessions | 200 | Максимальное количество активных сессий редактора (документы, открытые с помощью DocOptions.EditMode). При превышении закрывается самая давно неиспользуемая простаивающая сессия редактора. Обычные сессии просмотрщика не учитываются. 0 или отрицательное значение означают отсутствие ограничения. |
EditorSnapshotEveryOps | 50 | При включённой постоянстве редактора (AddDoconutEditorPersistence) делайте снимок живого документа каждые N зафиксированных изменений. 0 или отрицательное значение никогда не делают снимок в середине сессии. Не влияет, если постоянство отключено. |
Приоритет лицензий, когда задано более одного источника: LicenseStream превалирует над LicenseContent, который превалирует над LicensePath, который превалирует над авто‑поиском — см. Настройка лицензии.
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;
});Следующие шаги
- Быстрый старт — откройте ваш первый документ и отобразите его в браузере.
- Настройка лицензии — где Doconut ищет ваш файл лицензии.
Была ли эта страница полезной?