Nastavení licence

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

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, a přesné pořadí, když je nastaveno více než jedno.

Čtyři způsoby, jak dodat licenci

Existují čtyři: tři explicitní zdroje na DoconutOptions — proud, surový obsah nebo cesta k souboru — plus automatické vyhledávání, když není žádný 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ím adresáři procesu — ne k vašemu projektovému adresáři a ne k adresáři, ve kterém žije Program.cs. Pokud cesta není nalezena, 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 per-plugin ve stejném adresáři (Doconut.Viewer.<Capability>.lic) jsou s ním načteny, takže LicensePath a AddPlugin<...>() fungují společně, když pluginové licence leží 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");
});

Pomocí proudu

LicenseStream se načte 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;
});

Pomocí 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řekonán 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 sám hledá licenci, pouze v těchto dvou složkách:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot uvnitř složky výstupu sestavení)
// Nejprve hledá Doconut.lic; pokud chybí, hledá Doconut.Viewer.lic a jakékoli
// per-plugin Doconut.Viewer.<Capability>.lic soubory.
builder.Services.AddDoconut();

Složky pro prohledávání, 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-plugin licenses, read only when Doconut.Viewer.lic was found

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

Zkopírujte licenci do výstupní složky

Když proces neběží z projektové složky — publikovaná aplikace, IIS, kontejner, testovací runner — první prohledávání selže a druhé, {AppContext.BaseDirectory}/wwwroot, musí soubor najít. Tento MSBuild cíl 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, aby přejmenování nebo odstranění .lic v wwwroot také odstranilo soubor z výstupu. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Cíl 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 injektujte 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, na každém sestavení vydaném před tímto datem.

Pluginy potřebují funkce

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 funkce 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 problém: buď odeberete volání options.AddPlugin<...>() pro tento plugin, nebo nainstalujete placenou licenci či aktivní dočasnou/Demo (NFR) licenci, která poskytuje tuto funkci. Dočasné registrace jsou povoleny přežít datum vypršení, takže již nakonfigurovaná aplikace může během běhu degradovat místo toho, aby se při restartu zhroutila; po vypršení jsou jejich funkce stále odvolá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 se načítá během registrace AddDoconut(). ResetLicense je v současnosti kompatibilní vlastnost bez aktivní cesty pro opětovné načtení, takže nahrazení licenčního souboru vyžaduje restart aplikace.

Matice řešení problémů

SymptomPravděpodobná příčinaKontrola
Prohlížeč funguje, ale každá stránka má vodotiskNebyla načtena žádná licence, nebo dočasná licence vypršelaVyřešte IDoconutLicenseService; ověřte výstupní adresář a pracovní adresář procesu
AddDoconut() vyhazuje pro pluginLicence neposkytuje tuto funkci pluginuZkontrolujte IsCapabilityGranted(...) a odstraňte 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ý efektJednotková licenční služba již byla vytvořenaRestartujte aplikaci
OpenDocumentAsync vyhazuje 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í, aniž byste ji vystavili nedůvěryhodným klientům

Další kroky

  • Licensing — funkce, úrovně licencí a ověřování toho, co bylo načteno během běhu.
  • Troubleshooting — vodotisky, odmítnuté licence a chyby funkcí.

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