Nastavení licence

Kde Doconut hledá váš licenční soubor

Bez licence Doconut stále vykresluje dokumenty — každá stránka nese pouze vodotisk hodnocení. Tato stránka popisuje čtyři způsoby, jak dodat licenci, a přesné pořadí, když je nastaveno více než jedno.

Licence je načtena jednou, během AddDoconut(). To je změna oproti předchozí knihovně .NET Standard, kde byla licence předána instanci Viewer nebo nastavena pomocí statických volání Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...). Tyto metody nejsou v tomto vydání spouštěcím mechanismem — viz průvodce migrací.

Čtyři způsoby, jak dodat licenci

Existují čtyři: tři explicitní zdroje na DoconutOptions — proud, surový obsah nebo cesta k souboru — a automatické vyhledávání, když není žádný z nich nastaven. Když je nastaveno více než jedno, pořadí je přesně:

LicenseStream převyšuje LicenseContent převyšuje LicensePath převyšuje automatické vyhledávání.

Podle cesty

LicensePath je předáno File.Exists přesně tak, jak je. Relativní cesta se vyhodnocuje vůči aktuálnímu pracovnímu adresáři procesu — ne k vašemu projektovému adresáři a ne k adresáři, ve kterém žije Program.cs. Pokud se cesta nevyřeší, Doconut nevyhodí výjimku a ne přejde na automatické vyhledávání — jednoduše nenačte žádnou licenci a prohlížeč přidá vodotisk. Automatické vyhledávání běží jen když není nastaveno žádné z LicensePath, LicenseContent nebo LicenseStream. Licenční soubory pro jednotlivé pluginy ve stejném adresáři (Doconut.Viewer.<Capability>.lic) jsou s ním načteny, takže LicensePath a AddPlugin<...>() spolupracují, když licencemi pluginů jsou vedle základní licence.

Upřednostněte absolutní cestu (například vytvořenou z IWebHostEnvironment.WebRootPath nebo AppContext.BaseDirectory), nebo úplně vynechte LicensePath a spolehněte se na automatické vyhledávání níže.

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

Podle proudu

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

csharp
// Priorita: LicenseStream > LicenseContent > LicensePath > automatické vyhledávání.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

Podle obsahu

LicenseContent přijímá samotný text licence — z proměnné prostředí, databáze nebo tajného správce:

csharp
// License XML z databáze, proměnné prostředí nebo správce tajemství —
// žádný soubor na disku. Převážen pouze LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatické vyhledávání

Nenastavte žádný ze tří explicitních zdrojů a Doconut sám vyhledá licenci:

csharp
// Není nic konfigurováno a Doconut hledá licenci sám, pouze v těchto dvou složkách:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot uvnitř složky výstupního sestavení)
// Nejprve hledá Doconut.lic; pokud chybí, hledá Doconut.Viewer.lic plus jakékoli
// per-capability Doconut.Viewer.<Capability>.lic soubory.
builder.Services.AddDoconut();

Prohledávané složky v pořadí a názvy souborů, které se hledají:

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-capability licenses, read only when Doconut.Viewer.lic was found

Nic mimo složku wwwroot není čteno: .lic ve výstupní složce samotné nebo v wwwroot/lib je ignorováno.

Pokud jste dříve předali List<string> cest k licencím konstruktoru Viewer — jeden pro každou schopnost — udržujte tyto doprovodné soubory vedle Doconut.Viewer.lic a nechte automatické vyhledávání je zachytit. Na DoconutOptions neexistuje možnost seznamu cest.

Zkopírujte licenci do výstupního adresáře

Když proces neběží ze složky projektu — publikovaná aplikace, IIS, kontejner, testovací běh — první pokus selže a druhý, {AppContext.BaseDirectory}/wwwroot, musí soubor najít. Tento cíl MSBuild kopíruje licence tam při každém sestavení:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- Nejprve smazat, takže přejmenování nebo odstranění souboru .lic ve wwwroot jej také odstraní z výstupu. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Cílové umístění musí být $(OutDir)wwwroot: .lic zkopírovaný do kořene výstupu není nikdy nalezen automatickým vyhledáváním. Příklady LicensePath na této stránce ukazují na stejné místo.

Uchovávejte soubory .lic mimo správu verzí — nasazujte je vedle aplikace, nebo vložte licenci pomocí LicenseContent nebo LicenseStream z vašeho tajného úložiště.

Co se stane bez licence

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

Licenční soubor, který je nalezen, ale odmítnut, je jiný. Neplatný podpis, manipulace, zařazení na černou listinu nebo sestavení mimo časové okno licence způsobí, že OpenDocumentAsync vyhodí LicenseException s License.RejectionMessage. 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 schopnostmi, u každého sestavení vydaného před tímto datem.

Pluginy potřebují oprávnění

Registrace pluginu bez odpovídajícího oprávnění je jiná: při chybějící licenci, starém souboru TRIAL nebo placené licenci bez této schopnosti AddDoconut() vyhodí InvalidOperationException, takže se aplikace nespustí. Například registrace pluginu Converter bez licence, která poskytuje Converter:

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.

Zpráva vám přímo říká, jak opravit: buď odeberete volání options.AddPlugin<...>() pro tento plugin, nebo nainstalujete placenou licenci či aktivní dočasnou/Demo (NFR) licenci, která poskytuje tuto schopnost. Dočasné registrace mohou přežít datum vypršení, takže již nakonfigurovaná aplikace může během běhu degradovat místo toho, aby se během restartu zhroutila; po vypršení jsou jejich schopnosti stále odebrány.

Ověřte načtenou licenci

Použijte IDoconutLicenseService, stejný zdroj pravdy používaný SDK, k vystavení autentizovaného diagnostického koncového bodu nebo k řízení příznaků funkcí. Neukazujte obsah licence ani klíče.

csharp
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
}));

Licence je načtena během registrace AddDoconut(). ResetLicense je v současnosti kompatibilní vlastnost bez aktivní cesty pro opětovné načtení, takže výměna licenčního souboru vyžaduje restart aplikace.

Matice řešení problémů

PříznakPravděpodobná příčinaKontrola
Prohlížeč funguje, ale každá stránka má vodotiskNebyla načtena licence, nebo dočasná licence vypršelaVyřešte IDoconutLicenseService; ověřte výstupní adresář a pracovní adresář procesu
AddDoconut() vyhodí pro pluginLicence neposkytuje tuto schopnost pluginuZkontrolujte IsCapabilityGranted(...) a odeberte registrace, které jste nezakoupili
Nakonfigurovaná relativní cesta funguje lokálně, ale ne v IIS/kontejneruPracovní adresář procesu se změnilPoužijte AppContext.BaseDirectory nebo absolutní cestu
Nahrazený soubor .lic nemá žádný efektSlužba licence singleton byla již vytvořenaRestartujte aplikaci
OpenDocumentAsync vyhodí LicenseExceptionPodpis, doména, časové okno verze, černá listina nebo runtime gate pluginu odmítly licenciPřečtěte zprávu o výjimce/odmítnutí bez jejího vystavení nedůvěryhodným klientům
Licence na úrovni schopnosti fungovala dříve, ale nyní neStarý kód předával explicitní cesty k licencím do konstruktoru ViewerPřesuňte doprovodné soubory .lic vedle Doconut.Viewer.lic a nechte automatické vyhledávání je načíst

Další kroky

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