Instalación

Agregar Doconut a tu proyecto .NET 8

El visor base Doconut para .NET 8 se entrega como un paquete NuGet que se integra en cualquier aplicación ASP.NET Core. Los complementos opcionales usan paquetes separados. Esta página instala el paquete base y registra el middleware — lo mínimo necesario antes de tu primera renderización.

Requisitos

El paquete funciona en estas plataformas:

PlataformaCompatible
Windows x64 / x86Sí
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:8.0 image)Sí
Alpine y otras distribuciones basadas en muslNo
macOSNo

En Linux, instala la biblioteca de configuración de fuentes antes de que se abra el primer documento:

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

En RHEL, Fedora y distribuciones similares, el paquete es fontconfig (dnf install -y fontconfig). Ese es el único paquete del sistema que Doconut necesita: las bibliotecas nativas que usa se incluyen dentro del paquete NuGet, y libgdiplus no es necesario. Las páginas se dibujan con las fuentes instaladas en el servidor, así que consulta Resolución de problemas para fuentes y los mensajes de error de Linux.

Instalar el paquete

bash
dotnet add package Doconut.NET8

El comando sin versión instala la última versión estable. Para fijar la versión que describe esta documentación, pasa la versión como una opción separada:

bash
dotnet add package Doconut.NET8 --version 26.10.0

Doconut.NET8 es el ID del paquete. El sufijo de versión pertenece al nombre de archivo Doconut.NET8.<version>.nupkg descargado y no forma parte del ID.

Registrar Doconut

AddDoconut() es el único punto de entrada de registro — hay una sola sobrecarga, y conecta el servicio Viewer, el servicio de licencia y la infraestructura de renderizado al contenedor DI.

Dos llamadas de middleware completan la configuración, y su orden es importante: UseDoconutResources() debe ejecutarse antes que UseDoconut(). UseDoconut() es middleware terminal, por lo que llamarlo primero significa que cualquier solicitud a un recurso /doconut-res nunca llega al manejador de recursos y genera 404. UseDoconut() responde a cada solicitud que le llega, así que colócalo en su propia rama con app.Map. El cableado de sesión también es necesario — la seguridad de documento predeterminada de Doconut valida cada solicitud de página contra el estado de sesión de ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // el estado de sesión necesita una caché (MVC/Razor Pages ya añaden una)
builder.Services.AddSession(); // La seguridad de documentos Doconut depende del estado de sesión de ASP.NET

app.UseSession();          // llame a UseSession() antes de UseDoconut()
app.UseDoconutResources(); // debe registrarse antes de UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Todas las opciones

DoconutOptions acepta las siguientes propiedades configurables. Cada una es opcional — los valores predeterminados a continuación se aplican cuando una propiedad no se establece.

PropiedadPredeterminadoDescripción
ShowDoconutInfofalseCuando true, una solicitud sin token devuelve una pancarta de versión en lugar de un 404. Útil como verificación rápida; desactívalo en producción.
UnsafeModefalseCuando true, omite la verificación de seguridad de sesión ASP.NET en las solicitudes de página. Desactívalo en producción.
MiddlewarePath"/doconut"Valor de coordinación para el endpoint page-image. Se valida, pero no monta una rama por sí mismo; mantenlo alineado con el mapeo real de UseDoconut() y el BasePath del cliente.
ResourcesPath"/doconut-res"Desde dónde se sirven los recursos incrustados JS/CSS/imagen.
LicensePath"" (empty string)Ruta al archivo de licencia. Vacío significa pasar al siguiente origen, luego búsqueda automática.
LicenseContent"" (empty string)Contenido de licencia sin procesar — desde una variable de entorno, un gestor de secretos o una base de datos.
LicenseStreamnullLicencia como flujo, leída una vez al iniciar.
ResetLicensefalseBandera de compatibilidad reservada. Los servicios actuales de .NET 8 leen la licencia durante AddDoconut(); reinicia la aplicación después de reemplazar una licencia.
MaxConcurrentEditorSessions200Número máximo de sesiones de editor en vivo (documentos abiertos con DocOptions.EditMode). Por encima de este número, la sesión de editor inactiva menos recientemente usada se cierra. Las sesiones normales del visor nunca se cuentan. 0 o un valor negativo significa sin límite.
EditorSnapshotEveryOps50Con la persistencia del editor habilitada (AddDoconutEditorPersistence), crea una instantánea del documento en vivo cada N cambios registrados. 0 o un valor negativo nunca crea instantáneas durante la sesión. No tiene efecto cuando la persistencia está deshabilitada.

Prioridad de licencia cuando se establece más de una fuente: LicenseStream supera a LicenseContent, que supera a LicensePath, que supera a la búsqueda automática — consulta Configuración de licencia.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // coordine con el mapeo de la aplicación y BasePath del cliente
    options.ResourcesPath   = "/doconut-res"; // desde donde se sirven los JS/CSS/images del visor
    options.UnsafeMode      = false;          // mantenga la seguridad de sesión activada
    options.ShowDoconutInfo = false;
});

Próximos pasos

¿Fue útil esta página?