Nastavení licence

Kde Doconut hledá soubor licence pod IIS

Bez licence Doconut stále vykresluje dokumenty — každá stránka nese vodotisk s hodnocením. Tato stránka popisuje čtyři způsoby, jak dodat licenci v Global.asax, kde Doconut hledá, když žádnou neposkytnete, a co se stane, když licence pluginu chybí.

Čtyři způsoby, jak dodat licenci

Na DoconutOptions jsou tři explicitní zdroje — cesta k souboru, proud nebo surový obsah — plus automatické vyhledání, když není žádný nastaven. Všechny jsou načteny jednou, v DoconutHost.Initialize. Když je nastaveno více než jedno, precedence je přesná:

LicenseStream převáží LicenseContent převáží LicensePath převáží automatické vyhledání.

Podle cesty

Poskytněte LicensePath úplnou cestu. Relativní cesta je vyřešena vůči aktuálnímu adresáři procesu a pod IIS je to vlastní složka pracovního procesu, ne vašeho webu. HostingEnvironment.MapPath převádí cestu relativní k webu na úplnou:

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

Pokud soubor neexistuje, Doconut nevyhodí výjimku a ne přejde na automatické vyhledání: nenačte žádnou licenci a prohlížeč přidá vodotisk. Licenční soubory pro jednotlivé pluginy ve stejné složce (Doconut.Viewer.<Capability>.lic) jsou načteny spolu s ní, takže LicensePath a AddPlugin<...>() fungují společně, když licence pluginů leží vedle základní licence.

Pomocí proudu

LicenseStream je načten jednou při spuštění — užitečné, když licence pochází z vloženého zdroje nebo tajného úložiště místo souboru na disku.

csharp
// Priorita: LicenseStream > LicenseContent > LicensePath > auto-search.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Pomocí obsahu

LicenseContent přijímá samotný text licence — z proměnné prostředí, databáze nebo tajného úložiště — takže není nutné nasazovat soubor licence s webem.

csharp
// License XML z databáze, proměnné prostředí nebo tajného úložiště -
// žádný soubor na disku. Převážen pouze LicenseStream.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatické vyhledání

Nenastavíte žádný ze tří, a Doconut sám hledá licenci:

csharp
// Není potřeba žádná konfigurace a Doconut hledá licenci sám, v tomto pořadí:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (pod IIS: kořenová složka webu)
// Nejprve hledá Doconut.lic; pokud chybí, Doconut.Viewer.lic plus jakýkoli
// per-plugin Doconut.Viewer.<Capability>.lic soubory.
Doconut.DoconutHost.Initialize();

Dvě složky, v pořadí, a soubory, které jsou hledány:

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

Pod IIS a IIS Express je AppContext.BaseDirectory kořenová složka webu — ta, která obsahuje Web.config — ne její složka bin. Licence tedy patří do wwwroot pod kořenem webu:

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

V projektu uchovávejte wwwroot\*.lic vedle Web.config a nasazujte složku s webem. Není potřeba žádný krok sestavení, který by ji kopíroval kamkoli. .lic kdekoliv jinde — v bin\, vedle Web.config, nebo v podsložce wwwroot — se nikdy nečte.

Uchovávejte soubory .lic mimo správu verzí. Nasazujte je vedle webu, nebo poskytněte licenci přes LicenseContent nebo LicenseStream z vašeho tajného úložiště.

Co se stane bez licence

Chybějící licence nevyvolá výjimku. DoconutHost.Initialize uspěje, stránka se spustí a prohlížeč běží, ale každá stránka nese vodotisk hodnocení a žádná volitelná funkce není poskytnuta.

Soubor licence, který je nalezen, ale odmítnut, je jiný. Neplatný podpis, manipulace nebo sestavení mimo časové okno licence způsobí, že OpenDocumentAsync vyhodí LicenseException s důvodem. Vypršená dočasná licence pokračuje v režimu s vodotiskem. Placená licence, jejíž datum předplatného uplynulo, nadále funguje, čistě a se svými funkcemi, na každém sestavení vydaném před tímto datem.

Pluginy potřebují svou licenci při spuštění

Registrace pluginu, jehož funkci žádná licence nepřiděluje, zastaví aplikaci při spuštění. DoconutHost.Initialize vyhodí v 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.

V prostředí System.Web nevidíte tuto zprávu v prohlížeči. Každý požadavek na stránku odpoví prázdným 500 — žádná chybová stránka, žádný stack trace, nic v logu IIS. Výjimka je zaznamenána pouze v Windows event log (Application log, source ASP.NET). Pokud celý web přestane reagovat těsně po přidání řádku AddPlugin, zkontrolujte licenční soubory v wwwroot před kódem: Doconut.Viewer.<Capability>.lic pluginu musí být vedle Doconut.Viewer.lic, a bez základní licence nejsou soubory pluginu vůbec načteny.

Ověřte načtenou licenci

IDoconutLicenseService je stejný zdroj pravdy, který SDK používá. Získejte jej z DoconutHost.Services k vystavení autentizovaného diagnostického koncového bodu nebo řízení feature flagů — nikdy nevracejte obsah 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);
}

Licence je načtena jednou, v DoconutHost.Initialize. Po výměně souboru licence recyklujte aplikační pool (nebo upravte Web.config), aby Application_Start běžel znovu.

Odstraňování potíží

PříznakPravděpodobná příčinaKontrola
Prohlížeč funguje, ale každá stránka má vodotiskNebyla nalezena licenceJe .lic v <site root>\wwwroot? Zavolejte výše uvedený stavový endpoint
Každý požadavek odpovídá prázdným 500 těsně po přidání pluginuRegistrovaný plugin nemá licenci, která by mu to umožnilaWindows event log, source ASP.NET; .lic pluginu vedle Doconut.Viewer.lic
LicensePath funguje na vašem počítači, ale ne na serveruRelativní cesta vyřešená vůči složce pracovního procesuSestavte to s HostingEnvironment.MapPath("~/wwwroot/...")
Vyměněný soubor .lic nemá žádný efektLicence byla načtena při spuštění aplikaceRecyklujte aplikační pool
OpenDocumentAsync vyhodí LicenseExceptionLicence byla nalezena, ale odmítnutaPřečtěte zprávu výjimky; neukazujte ji nedůvěryhodným klientům

Další kroky

Byla tato stránka užitečná?