Licensinställning

Utan en licens renderar Doconut fortfarande dokument — varje sida har bara ett utvärderingsvattenstämpel. Den här sidan beskriver de fyra sätten att tillhandahålla en licens, samt den exakta prioritetsordningen när mer än en är angiven.

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 angiven. När mer än en är angiven är prioriteringen exakt:

LicenseStream slår LicenseContent slår LicensePath slår auto-sökning.

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å auto-sökning — den laddar helt enkelt ingen licens och visaren visar vattenstämplar. Auto-sökning körs endast när ingen av LicensePath, LicenseContent eller LicenseStream är angiven.

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.

builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "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.

// Precedence: LicenseStream > LicenseContent > LicensePath > auto-search.
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:

// License XML from a database, environment variable, or secret manager —
// no file on disk. Beaten only by LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatisk upptäkt

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

// Configure nothing, and Doconut searches for the license itself:
//   1. {CurrentDirectory}/wwwroot
//   2. {CurrentDirectory}/wwwroot/lib
//   3. AppContext.BaseDirectory  (the build output folder)
// It looks for Doconut.Viewer.lic plus any per-plugin
// Doconut.Viewer.<Capability>.lic files alongside it.
builder.Services.AddDoconut();

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

1. {CurrentDirectory}/wwwroot
2. {CurrentDirectory}/wwwroot/lib
3. AppContext.BaseDirectory

Filenames (checked in each directory above, in order):
  Doconut.Viewer.lic                   — base viewer license
  Doconut.Viewer.<Capability>.lic      — per-plugin license, alongside Doconut.Viewer.lic

Kopiera licensen till din utdata-mapp

LicensePath och auto-sökningens AppContext.BaseDirectory-probe kräver båda att .lic-filen finns bredvid den byggda appen — inte bara i din källkod wwwroot. SDK:ns egna testapp kopierar den vid varje byggnad med detta MSBuild-mål:

<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
  </ItemGroup>
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)" SkipUnchangedFiles="true" />
</Target>

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 en licens

En saknad licens kastar inte ett undantag. AddDoconut() lyckas, appen startar och visaren körs — men varje sida har en 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 kalenderutgången licens utan avvisningsmeddelande fortsätter i vattenstämpel-läge.

Plugins behöver funktioner

Att registrera en 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, registrering av Converter‑plugin utan en licens som beviljar Converter:

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 den pluginen, eller installera en betald licens eller en aktiv Tillfällig/Demo (NFR)-licens som beviljar funktionen. Tillfälliga 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 gått ut återkallas deras funktioner.

Verifiera den laddade licensen

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

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 att applikationen startas om.

Felsökningsmatris

Nästa steg

• Licensiering — funktioner, licensnivåer och verifiering av vad som laddades vid körning.
• Felsökning — vattenstämplar, avvisade licenser och funktionsfel.