Licensinställning

Var Doconut letar efter din licensfil

Utan en licens renderar Doconut fortfarande dokument — varje sida har bara ett utvärderingsvattenstämpel. Denna sida täcker de fyra sätten att tillhandahålla en licens, samt den exakta prioriteringen när mer än en är inställd.

Licensen laddas en gång, under AddDoconut(). Det är en förändring från det tidigare .NET Standard-biblioteket, där licensen överlämnades till en Viewer-instans eller sattes via de statiska Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...)-anropen. Dessa metoder är inte en uppstarts­mekanism i denna version — se migrationsguiden.

Fyra sätt att tillhandahålla en licens

Det finns fyra: tre explicita källor på DoconutOptions — en ström, rått innehåll eller en filsökväg — samt automatisk upptäckt när ingen av dem är inställd. När mer än en är inställd är prioriteringen exakt:

LicenseStream beats LicenseContent beats LicensePath beats auto-search.

Via sökväg

LicensePath skickas till File.Exists exakt som den är. En relativ sökväg löses mot processens aktuella arbetskatalog — inte din projektmapp, och inte den mapp där Program.cs finns. Om sökvägen inte kan lösas kastar Doconut inte ett undantag och faller inte tillbaka på automatisk sökning — den laddar helt enkelt ingen licens och visningsprogrammet visar vattenstämplar. Automatisk sökning körs endast när ingen av LicensePath, LicenseContent eller LicenseStream är inställd. Licensfilerna per plugin i samma mapp (Doconut.Viewer.<Capability>.lic) läses med den, så LicensePath och AddPlugin<...>() fungerar tillsammans när plugin‑licenserna ligger bredvid baslicensen.

Föredra en absolut sökväg (till exempel byggd från IWebHostEnvironment.WebRootPath eller AppContext.BaseDirectory), eller hoppa över LicensePath helt och hållet och förlita dig på automatisk upptäckt nedan.

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

Via ström

LicenseStream läses en gång vid start — användbart när licensen kommer från en hemlig lagring snarare än en fil på disk.

csharp
// Prioritet: LicenseStream > LicenseContent > LicensePath > auto-sökning.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

Via innehåll

LicenseContent accepterar själva licenstexten — från en miljövariabel, en databas eller en hemlig hanterare:

csharp
// Licens-XML från en databas, miljövariabel eller hemlig hanterare —
// ingen fil på disk. Överträffas endast av LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatisk upptäckt

Konfigurera ingen av de tre explicita källorna, så söker Doconut efter licensen själv:

csharp
// Konfigurera ingenting, och Doconut söker efter licensen själv, endast i dessa två mappar:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot i byggutdata-mappen)
// Den letar först efter Doconut.lic; om den saknas, Doconut.Viewer.lic plus eventuella
// per-förmåga Doconut.Viewer.<Capability>.lic-filer.
builder.Services.AddDoconut();

De sökvägar som genomsöks, i ordning, samt filnamnen som letas efter:

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

Ingenting utanför en wwwroot-mapp läses: en .lic i själva utmatningsmappen, eller i wwwroot/lib, ignoreras.

Om du tidigare har skickat en List<string> med licenssökvägar till Viewer-konstruktorn — en per funktion — behåll dessa medföljande filer bredvid Doconut.Viewer.lic och låt automatisk upptäckt plocka upp dem. Det finns inget alternativ för lista över sökvägar på DoconutOptions.

Kopiera licensen till din output-mapp

När processen inte körs från projektmappen — en publicerad app, IIS, en container, en testkörare — missar den första sökningen, och den andra, {AppContext.BaseDirectory}/wwwroot, måste hitta filen. Detta MSBuild-mål kopierar licenserna dit vid varje byggnad:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- Ta bort först, så att en namnändring eller borttagning av en .lic i wwwroot också tas bort från utdata. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Destinationen måste vara $(OutDir)wwwroot: en .lic kopierad till output-roten hittas aldrig av autosökning. LicensePath-exemplen på den här sidan pekar på samma plats.

Håll .lic-filer utanför källkontrollen — distribuera dem tillsammans med appen, eller injicera licensen via LicenseContent eller LicenseStream från din hemliga lagring.

Vad händer utan licens

En saknad licens kastar inte ett undantag. AddDoconut() lyckas, appen startar, och visaren kör — men varje sida har ett utvärderingsvattenstämpel och ingen valfri funktion beviljas.

En licensfil som hittas men avvisas är annorlunda. En ogiltig signatur, manipulering, svartlistning eller en byggnad utanför licensens versionsfönster får OpenDocumentAsync att kasta LicenseException med License.RejectionMessage. En utgången temporär licens fortsätter i vattenstämpel-läge. En betald licens vars prenumerationsdatum har passerat fortsätter att fungera, ren och med sina funktioner, på varje byggnad som släppts före det datumet.

Plugins behöver funktioner

Att registrera ett plugin utan motsvarande rättighet är annorlunda: för en saknad licens, en äldre TRIAL-fil, eller en betald licens utan den funktionen, kastar AddDoconut() InvalidOperationException, så appen startar inte. Till exempel, att registrera Converter‑pluginet utan en licens som beviljar 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.

Meddelandet talar om lösningen direkt: antingen ta bort options.AddPlugin<...>()‑anropet för det pluginet, eller installera en betald licens eller en aktiv temporär/Demo (NFR)-licens som beviljar funktionen. Temporära registreringar får överleva sitt utgångsdatum så att en redan konfigurerad app kan degraderas vid körning istället för att krascha vid omstart; när de har löpt ut är deras funktioner fortfarande återkallade.

Verifiera den laddade licensen

Använd IDoconutLicenseService, samma sanningskälla som SDK:n använder, för att exponera en autentiserad diagnostikendpoint eller för att styra funktionsflaggor. Returnera inte licensinnehåll eller nycklar.

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

Licensen läses under AddDoconut()‑registreringen. ResetLicense är för närvarande en kompatibilitetsegenskap utan aktiv omladdningsväg, så att ersätta en licensfil kräver en omstart av applikationen.

Felsökningsmatris

SymptomTrolig orsakKontrollera
Visaren fungerar men varje sida är vattenmärktIngen licens laddades, eller den temporära licensen har gått utLös IDoconutLicenseService; verifiera output‑katalogen och processens arbetskatalog
AddDoconut() kastar för ett pluginLicensen beviljar inte den plugin‑funktionenKontrollera IsCapabilityGranted(...) och ta bort registreringar du inte har köpt
En konfigurerad relativ sökväg fungerar lokalt men inte i IIS/containerProcessens arbetskatalog ändradesAnvänd AppContext.BaseDirectory eller en absolut sökväg
Ersatt .lic‑fil har ingen effektDen enkla licenstjänsten var redan skapadStarta om applikationen
OpenDocumentAsync kastar LicenseExceptionSignatur, domän, versionsfönster, svartlista eller plugin‑runtime‑gate avvisade licensenLäs undantags-/avvisningsmeddelandet utan att exponera det för opålitliga klienter
En per‑funktion‑licens fungerade tidigare men inte nuDen gamla koden skickade explicita licenssökvägar till Viewer‑konstruktornFlytta de medföljande .lic‑filerna bredvid Doconut.Viewer.lic och låt automatisk upptäckt ladda dem

Nästa steg

  • Licensiering — funktioner, licenstier och verifiera vad som laddades vid körning.
  • Felsökning — vattenstämplar, avvisade licenser och fel i funktioner.

Var den här sidan hjälpsam?