Configuración de Licencia

Sin una licencia, Doconut sigue renderizando 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 crudo 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 búsqueda automática.

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 plugin 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 plugins están al lado de la licencia base.

Prefiera una ruta absoluta (por ejemplo construida a partir de IWebHostEnvironment.WebRootPath o AppContext.BaseDirectory), o omita LicensePath por completo y confíe 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 directamente — desde 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 configure ninguna de las tres fuentes explícitas, y Doconut buscará la licencia por sí mismo:

// No configure 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 primero Doconut.lic, luego Doconut.Viewer.lic, más cualquier 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

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

Copie la licencia a su 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, debe 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>
  <!-- Elimine primero, de modo que renombrar o eliminar un .lic en wwwroot también lo elimine 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.

Mantenga los archivos .lic fuera del control de versiones — desplieguelos junto a la aplicación, o inyecte la licencia a través de LicenseContent o LicenseStream desde su 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 legado TRIAL, o una licencia de pago 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: elimine la llamada options.AddPlugin<...>() para ese complemento, o instale una licencia de pago 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 reiniciar; 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 punto final de diagnóstico autenticado o para controlar banderas de características. No devuelva el contenido de la licencia ni las 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 verificación de lo que se cargó en tiempo de ejecución.
• Solución de problemas — marcas de agua, licencias rechazadas y errores de capacidad.