Configuración de Licencia

Dónde Doconut busca su archivo de licencia bajo IIS

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 en Global.asax, dónde Doconut busca cuando no se proporciona ninguna, y qué ocurre cuando falta la licencia de un complemento.

Cuatro formas de proporcionar una licencia

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

LicenseStream supera a LicenseContent supera a LicensePath supera al descubrimiento automático.

Por ruta

Proporcione a LicensePath una ruta completa. Una ruta relativa se resuelve contra el directorio actual del proceso, y bajo IIS eso es la carpeta propia del proceso de trabajo, no su sitio. HostingEnvironment.MapPath convierte una ruta relativa al sitio en una completa:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});

Si el archivo no existe, Doconut no lanza una excepción y no recurre al descubrimiento automático: no carga ninguna licencia, y el visor muestra marcas de agua. Los archivos de licencia por complemento en la misma carpeta (Doconut.Viewer.<Capability>.lic) se leen junto con ella, de modo que LicensePath y AddPlugin<...>() funcionan juntos cuando las licencias de los complementos están al lado de la licencia base.

Por flujo

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

csharp
// Prioridad: LicenseStream > LicenseContent > LicensePath > búsqueda automática.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Por contenido

LicenseContent toma el texto de la licencia mismo — de una variable de entorno, una base de datos o un almacén secreto — por lo que no es necesario desplegar un archivo de licencia con el sitio.

csharp
// XML de licencia desde una base de datos, una variable de entorno o un almacén secreto -
// sin archivo en disco. Solo superado por LicenseStream.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Descubrimiento automático

No configure ninguno de los tres, y Doconut busca la licencia por sí mismo:

csharp
// No configure nada, y Doconut busca la licencia por sí mismo, en este orden:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (en IIS: la carpeta raíz del sitio)
// Busca Doconut.lic primero; si falta, Doconut.Viewer.lic más cualquier
// archivos .lic por complemento Doconut.Viewer.<Capability>.
Doconut.DoconutHost.Initialize();

Las dos carpetas, en orden, y los nombres de archivo buscados:

text
1. {CurrentDirectory}\wwwroot
2. {AppContext.BaseDirectory}\wwwroot

Filenames, in order (each one looked for in folder 1, then folder 2):
  Doconut.lic                        — legacy all-in-one license; if found, nothing else is read
  Doconut.Viewer.lic                 — base viewer license
  Doconut.Viewer.<Capability>.lic    — per-plugin licenses, read only when Doconut.Viewer.lic was found

En IIS e IIS Express, AppContext.BaseDirectory es la carpeta raíz del sitio — la que contiene Web.config — no su carpeta bin. Por lo tanto, la licencia debe estar en wwwroot bajo la raíz del sitio:

text
MySite\
  Web.config
  Global.asax
  bin\
  wwwroot\
    Doconut.Viewer.lic
    Doconut.Viewer.Converter.lic

En el proyecto, mantenga wwwroot\*.lic junto a Web.config y despliegue la carpeta con el sitio. No es necesario que ningún paso de compilación lo copie a ningún lugar. Un .lic en cualquier otro lugar — en bin\, junto a Web.config, o en una subcarpeta de wwwroot — nunca se lee.

Mantenga los archivos .lic fuera del control de versiones. Desplieguelos junto al sitio, o proporcione 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. DoconutHost.Initialize tiene éxito, el sitio 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 se rechaza es diferente. Una firma inválida, manipulación, o una compilación fuera de la ventana de versión de la licencia hace que OpenDocumentAsync lance LicenseException con la razón. Una licencia Temporal caducada continúa en modo con marca de agua. Una licencia de pago cuya fecha de suscripción ha pasado sigue funcionando, limpia y con sus capacidades, en cada compilación lanzada antes de esa fecha.

Los complementos necesitan su licencia al iniciar

Registrar un complemento cuya capacidad no es concedida por ninguna licencia detiene la aplicación al iniciar. DoconutHost.Initialize lanza en Application_Start:

text
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.

En System.Web, no ves ese mensaje en el navegador. Cada solicitud al sitio responde con un 500 vacío — sin página de error, sin rastreo de pila, nada en el registro IIS. La excepción se registra solo en el registro de eventos de Windows (registro de Aplicación, origen ASP.NET). Si todo el sitio deja de responder justo después de agregar una línea AddPlugin, verifica los archivos de licencia en wwwroot antes del código: el Doconut.Viewer.<Capability>.lic del complemento debe estar junto a Doconut.Viewer.lic, y sin la licencia base los archivos del complemento no se leen en absoluto.

Verificar la licencia cargada

IDoconutLicenseService es la misma fuente de verdad que usa el SDK. Resuélvelo desde DoconutHost.Services para exponer un endpoint de diagnóstico autenticado o controlar banderas de características — nunca devuelvas el contenido de la licencia:

csharp
// GET /License/Status
public ActionResult Status()
{
    var license = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(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
    }, JsonRequestBehavior.AllowGet);
}

La licencia se lee una sola vez, en DoconutHost.Initialize. Después de reemplazar un archivo de licencia, recicla el pool de aplicaciones (o toca Web.config) para que Application_Start se ejecute de nuevo.

Solución de problemas

SíntomaCausa probableVerificar
El visor funciona pero cada página tiene marca de aguaNo se encontró licencia¿Está el .lic en <site root>\wwwroot? Llame al endpoint de estado arriba
Cada solicitud responde con un 500 vacío justo después de agregar un complementoUn complemento registrado no tiene licencia que lo concedaRegistro de eventos de Windows, origen ASP.NET; el .lic del complemento junto a Doconut.Viewer.lic
LicensePath funciona en tu máquina pero no en el servidorUna ruta relativa resuelta contra la carpeta del proceso de trabajoCompílalo con HostingEnvironment.MapPath("~/wwwroot/...")
Un archivo .lic reemplazado no tiene efectoLa licencia se leyó cuando la aplicación se inicióRecicla el pool de aplicaciones
OpenDocumentAsync lanza LicenseExceptionLa licencia se encontró pero se rechazóLee el mensaje de la excepción; no lo muestres a clientes no confiables

Próximos pasos

  • Licencias — capacidades, y cómo verificarlas en tiempo de ejecución.
  • Solución de problemas — marcas de agua, fallos al iniciar, y otros síntomas.

¿Fue útil esta página?