Configuración de Licencia

Sin una licencia, Doconut aún renderiza documentos — cada página solo lleva una marca de agua de evaluación. Esta página cubre las cuatro formas de proporcionar una licencia, y la precedencia exacta cuando se establece más de una.

Cuatro formas de proporcionar una licencia

Hay cuatro: tres fuentes explícitas en DoconutOptions — un flujo, contenido sin procesar o una ruta de archivo — más el descubrimiento automático cuando ninguna de ellas está configurada. Cuando se establece más de una, la precedencia es exacta:

LicenseStream supera a LicenseContent supera a LicensePath supera a auto-search.

Por ruta

LicensePath se pasa a File.Exists exactamente como se da. Una ruta relativa se resuelve contra el directorio de trabajo actual del proceso — no la carpeta de tu proyecto, y no la carpeta donde vive Program.cs. Si la ruta no se resuelve, Doconut no lanza una excepción y no recurre a la búsqueda automática — simplemente no carga ninguna licencia y el visor muestra marcas de agua. La búsqueda automática solo se ejecuta cuando ninguno de LicensePath, LicenseContent o LicenseStream está configurado. Los archivos de licencia por complemento en la misma carpeta (Doconut.Viewer.<Capability>.lic) se leen con ella, de modo que LicensePath y AddPlugin<...>() funcionan juntos cuando las licencias de los complementos están al lado de la licencia base.

Prefiere una ruta absoluta (por ejemplo construida a partir de IWebHostEnvironment.WebRootPath o AppContext.BaseDirectory), o omite LicensePath por completo y confía en el descubrimiento automático a continuación.

builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});

Por flujo

LicenseStream se lee una vez al iniciar — útil cuando la licencia proviene de un almacén secreto en lugar de un archivo en disco.

// Prioridad: LicenseStream > LicenseContent > LicensePath > búsqueda automática.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

Por contenido

LicenseContent acepta el texto de la licencia mismo — de una variable de entorno, una base de datos o un gestor de secretos:

// XML de licencia desde una base de datos, variable de entorno o gestor de secretos —
// no hay archivo en disco. Solo superado por LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Descubrimiento automático

No configures ninguna de las tres fuentes explícitas, y Doconut busca la licencia por sí mismo:

// No configures nada, y Doconut busca la licencia por sí mismo, solo en estas dos carpetas:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot dentro de la carpeta de salida de compilación)
// Busca Doconut.lic primero, luego Doconut.Viewer.lic, más cualquier archivo por complemento
// archivos Doconut.Viewer.<Capability>.lic junto a él.
builder.Services.AddDoconut();

Las carpetas de inspección, en orden, y los nombres de archivo buscados en cada una:

1. {CurrentDirectory}/wwwroot
2. {AppContext.BaseDirectory}/wwwroot

Filenames (checked in each folder above, in order):
  Doconut.lic                          — base viewer license (checked first)
  Doconut.Viewer.lic                   — base viewer license
  Doconut.Viewer.<Capability>.lic      — per-plugin license, alongside the base license

Nada fuera de una carpeta wwwroot se lee: un .lic en la propia carpeta de salida, o en wwwroot/lib, se ignora.

Copia la licencia a tu carpeta de salida

Cuando el proceso no se ejecuta desde la carpeta del proyecto — una aplicación publicada, IIS, un contenedor, un ejecutor de pruebas — la primera inspección falla, y la segunda, {AppContext.BaseDirectory}/wwwroot, tiene que encontrar el archivo. La propia aplicación de pruebas del SDK copia las licencias allí en cada compilación con este objetivo MSBuild:

<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- Elimina primero, de modo que renombrar o eliminar un .lic en wwwroot también lo elimina de la salida. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

El destino debe ser $(OutDir)wwwroot: un .lic copiado a la raíz de salida nunca es encontrado por la búsqueda automática. Los ejemplos LicensePath en esta página apuntan al mismo lugar.

Mantén los archivos .lic fuera del control de versiones — despléguelos junto a la aplicación, o inyecta la licencia a través de LicenseContent o LicenseStream desde tu almacén secreto.

Qué ocurre sin una licencia

Una licencia faltante no lanza una excepción. AddDoconut() tiene éxito, la aplicación se inicia y el visor se ejecuta — pero cada página lleva una marca de agua de evaluación y no se concede ninguna capacidad opcional.

Un archivo de licencia que se encuentra pero es rechazado es diferente. Una firma inválida, manipulación, inclusión en lista negra, o una compilación fuera de la ventana de versiones de la licencia hace que OpenDocumentAsync lance LicenseException con License.RejectionMessage. Una licencia caducada por calendario que no tiene mensaje de rechazo continúa en modo con marca de agua.

Los complementos necesitan capacidades

Registrar un complemento sin la autorización correspondiente es diferente: para una licencia faltante, un archivo heredado TRIAL, o una licencia paga sin esa capacidad, AddDoconut() lanza InvalidOperationException, por lo que la aplicación no se inicia. Por ejemplo, registrar el complemento Converter sin una licencia que conceda Converter:

InvalidOperationException: The Converter plugin is registered via AddPlugin but no active
license grants Converter. Remove the AddPlugin<...>() call or install a license (or
trial/demo) that includes Converter.

El mensaje le indica la solución directamente: o elimine la llamada options.AddPlugin<...>() para ese complemento, o instale una licencia paga o una licencia Temporal/Demo (NFR) activa que conceda la capacidad. Las registraciones temporales pueden sobrevivir a su fecha de expiración para que una aplicación ya configurada pueda degradarse en tiempo de ejecución en lugar de fallar al reiniciarse; una vez expiradas, sus capacidades siguen revocadas.

Verificar la licencia cargada

Utilice IDoconutLicenseService, la misma fuente de verdad usada por el SDK, para exponer un endpoint de diagnóstico autenticado o para controlar banderas de funciones. No devuelva contenidos de la licencia ni claves.

app.MapGet("/api/doconut/license", (IDoconutLicenseService license) => Results.Ok(new
{
    viewer = license.IsViewerLicensed || license.IsTemporary,
    temporary = license.IsTemporary,
    search = license.IsCapabilityGranted(LicenseCapability.Search),
    annotation = license.IsCapabilityGranted(LicenseCapability.Annotation),
    converter = license.HasConverter,
    dicom = license.HasDicom
}));

La licencia se lee durante el registro AddDoconut(). ResetLicense es actualmente una propiedad de compatibilidad sin una ruta de recarga activa, por lo que reemplazar un archivo de licencia requiere reiniciar la aplicación.

Matriz de solución de problemas

Próximos pasos

• Licencias — capacidades, niveles de licencia y verificar lo que se cargó en tiempo de ejecución.
• Solución de problemas — marcas de agua, licencias rechazadas y errores de capacidad.