Configuration de licence

Où Doconut recherche votre fichier de licence sous IIS

Sans licence, Doconut rend toujours les documents — chaque page porte simplement un filigrane d'évaluation. Cette page décrit les quatre façons de fournir une licence dans Global.asax, où Doconut recherche lorsqu'aucune n'est fournie, et ce qui se passe lorsqu'une licence de plugin est manquante.

Quatre façons de fournir une licence

Il existe trois sources explicites sur DoconutOptions — un chemin de fichier, un flux ou du contenu brut — plus la découverte automatique lorsqu'aucune d'elles n'est définie. Toutes sont lues une fois, dans DoconutHost.Initialize. Lorsque plus d'une est définie, la priorité est exacte :

LicenseStream précède LicenseContent précède LicensePath précède la découverte automatique.

Par chemin

Fournissez à LicensePath un chemin complet. Un chemin relatif est résolu par rapport au répertoire de travail du processus, et sous IIS il s'agit du dossier propre au processus de travail, pas de votre site. HostingEnvironment.MapPath transforme un chemin relatif au site en un chemin complet :

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

Si le fichier n'existe pas, Doconut ne lève pas d'exception et ne revient pas à la découverte automatique : aucune licence n'est chargée, et le visualiseur applique un filigrane. Les fichiers de licence par plugin dans le même dossier (Doconut.Viewer.<Capability>.lic) sont lus avec celui‑ci, de sorte que LicensePath et AddPlugin<...>() fonctionnent ensemble lorsque les licences des plugins se trouvent à côté de la licence principale.

Par flux

LicenseStream est lu une fois, au démarrage — utile lorsque la licence provient d'une ressource incorporée ou d'un magasin secret plutôt que d'un fichier sur disque.

csharp
// Priorité : LicenseStream > LicenseContent > LicensePath > recherche automatique.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Par contenu

LicenseContent prend le texte de la licence lui‑même — provenant d'une variable d'environnement, d'une base de données ou d'un magasin secret — ainsi aucun fichier de licence n'a besoin d'être déployé avec le site.

csharp
// XML de licence provenant d’une base de données, d’une variable d’environnement ou d’un magasin secret -
// pas de fichier sur le disque. Seul LicenseStream le dépasse.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Découverte automatique

Ne définissez aucune des trois, et Doconut recherche lui‑même la licence :

csharp
// Ne configurez rien, et Doconut recherche la licence lui‑même, dans cet ordre :
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (sous IIS : le dossier racine du site)
// Il recherche d’abord Doconut.lic ; si celui‑ci est absent, Doconut.Viewer.lic ainsi que tout
// les fichiers Doconut.Viewer.<Capability>.lic par plugin.
Doconut.DoconutHost.Initialize();

Les deux dossiers, dans l'ordre, et les fichiers recherchés :

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

Sous IIS et IIS Express, AppContext.BaseDirectory est le dossier racine du site — celui qui contient Web.config — et non son dossier bin. Ainsi la licence doit se trouver dans wwwroot sous la racine du site :

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

Dans le projet, conservez wwwroot\*.lic à côté de Web.config et déployez le dossier avec le site. Aucune étape de construction n'a besoin de le copier ailleurs. Un .lic ailleurs — dans bin\, à côté de Web.config, ou dans un sous‑dossier de wwwroot — n'est jamais lu.

Gardez les fichiers .lic hors du contrôle de version. Déployez‑les à côté du site, ou fournissez la licence via LicenseContent ou LicenseStream depuis votre magasin secret.

Que se passe-t-il sans licence

Une licence manquante ne génère pas d'exception. DoconutHost.Initialize réussit, le site démarre et le visualiseur s'exécute, mais chaque page porte un filigrane d'évaluation et aucune capacité optionnelle n'est accordée.

Un fichier de licence trouvé mais rejeté est différent. Une signature invalide, une falsification ou une version construite en dehors de la fenêtre de version de la licence fait que OpenDocumentAsync lève LicenseException avec la raison. Une licence Temporaire expirée continue en mode filigrané. Une licence payante dont la date d'abonnement est passée continue de fonctionner, proprement et avec ses capacités, sur chaque build publié avant cette date.

Les plugins ont besoin de leur licence au démarrage

Enregistrer un plugin dont la capacité n'est accordée par aucune licence arrête l'application au démarrage. DoconutHost.Initialize lève une exception dans 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.

Sous System.Web, vous ne voyez pas ce message dans le navigateur. Chaque requête au site répond avec un 500 vide — aucune page d'erreur, aucune trace de pile, rien dans le journal IIS. L'exception n'est enregistrée que dans le journal des événements Windows (journal Application, source ASP.NET). Si l'ensemble du site cesse de répondre immédiatement après avoir ajouté une ligne AddPlugin, vérifiez les fichiers de licence dans wwwroot avant le code : le Doconut.Viewer.<Capability>.lic du plugin doit se trouver à côté de Doconut.Viewer.lic, et sans la licence de base les fichiers du plugin ne sont pas du tout lus.

Vérifier la licence chargée

IDoconutLicenseService est la même source de vérité utilisée par le SDK. Résolvez‑la depuis DoconutHost.Services pour exposer un point de terminaison de diagnostic authentifié ou piloter les drapeaux de fonctionnalités — ne jamais renvoyer le contenu de la licence :

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 licence est lue une fois, dans DoconutHost.Initialize. Après avoir remplacé un fichier de licence, recyclez le pool d'applications (ou touchez Web.config) afin que Application_Start s'exécute de nouveau.

Dépannage

SymptômeCause probableVérifier
Le visualiseur fonctionne mais chaque page est filigranéeAucune licence n'a été trouvéeLe .lic se trouve-t-il dans <site root>\wwwroot ? Appelez le point de terminaison d'état ci‑dessus
Chaque requête répond avec un 500 vide juste après l'ajout d'un pluginUn plugin enregistré n'a aucune licence qui le lui accordeJournal des événements Windows, source ASP.NET ; le .lic du plugin à côté de Doconut.Viewer.lic
LicensePath fonctionne sur votre machine mais pas sur le serveurUn chemin relatif résolu par rapport au dossier du processus de travailCompilez‑le avec HostingEnvironment.MapPath("~/wwwroot/...")
Un fichier .lic remplacé n'a aucun effetLa licence a été lue au démarrage de l'applicationRecyclez le pool d'applications
OpenDocumentAsync lève LicenseExceptionLa licence a été trouvée mais rejetéeLisez le message d'exception ; ne le montrez pas aux clients non fiables

Prochaines étapes

  • Gestion des licences — capacités, et comment les vérifier à l'exécution.
  • Dépannage — filigranes, échecs au démarrage et autres symptômes.

Cette page était-elle utile ?