Licensinställning
Var Doconut letar efter din licensfil
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 prioriteringen 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 automatisk sökning.
Via sökväg
LicensePath skickas till File.Exists exakt som angivet. En relativ sökväg löses mot processens aktuella arbetskatalog — inte din projektmapp, och inte den mapp som Program.cs finns i. Om sökvägen inte kan lösas, kastar Doconut inte ett fel och inte faller 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 angiven. 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.
builder.Services.AddDoconut(options =>
{
options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});Via ström
LicenseStream läses en gång vid uppstart — användbart när licensen kommer från en hemlig lagring snarare än en fil på disk.
// Prioritet: LicenseStream > LicenseContent > LicensePath > autosökning.
builder.Services.AddDoconut(options =>
{
options.LicenseStream = licenseStream;
});Via innehåll
LicenseContent accepterar licenstexten själv — från en miljövariabel, en databas eller en hemlig hanterare:
// Licens XML från en databas, miljövariabel eller hemlig hanterare —
// ingen fil på disk. Slås 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:
// 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-plugin Doconut.Viewer.<Capability>.lic-filer.
builder.Services.AddDoconut();De sökvägsmappar som genomsöks, i ordning, och filnamnen som letas efter:
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 foundIngenting utanför en wwwroot‑mapp läses: en .lic i själva utmatningsmappen, eller i wwwroot/lib, ignoreras.
Kopiera licensen till din utmatningsmapp
När processen inte körs från projektmappen — en publicerad app, IIS, en container, en testkörare — missar den första genomsökningen, och den andra, {AppContext.BaseDirectory}/wwwroot, måste hitta filen. Detta MSBuild‑mål kopierar licenserna dit vid varje byggnad:
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
<ItemGroup>
<DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
<StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
</ItemGroup>
<!-- Ta bort först, så att namnbyte 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 som kopieras till utmatningsroten hittas aldrig av automatisk sökning. LicensePath‑exemplen på den här sidan pekar på samma plats.
Håll
.lic‑filer utanför versionskontrollen — distribuera dem tillsammans med appen, eller injicera licensen viaLicenseContentellerLicenseStreamfrån din hemliga lagring.
Vad händer utan en licens
En saknad licens kastar inte. 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 Tillfällig licens fortsätter i vattenmärkt 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, AddDoconut() kastar InvalidOperationException, så appen startar inte. Till exempel, registrering av Converter‑pluginet 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 det pluginet, 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 ä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 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
| Symptom | Trolig orsak | Kontroll |
|---|---|---|
| Visaren fungerar men varje sida är vattenmärkt | Ingen licens laddades, eller den Tillfälliga licensen har gått ut | Lös IDoconutLicenseService; verifiera utdata‑katalogen och processens arbetskatalog |
AddDoconut() kastar för ett plugin | Licensen beviljar inte den plugin‑funktionen | Kontrollera IsCapabilityGranted(...) och ta bort registreringar du inte köpt |
| En konfigurerad relativ sökväg fungerar lokalt men inte i IIS/container | Processens arbetskatalog har ändrats | Använd AppContext.BaseDirectory eller en absolut sökväg |
Ersatt .lic‑fil har ingen effekt | Den enkla licenstjänsten hade redan skapats | Starta om applikationen |
OpenDocumentAsync kastar LicenseException | Signatur, domän, versionsfönster, svartlista eller plugin‑körningsgrind avvisade licensen | Läs undantags-/avvisningsmeddelandet utan att exponera det för opålitliga klienter |
Nästa steg
- Licensiering — funktioner, licenstier och verifiera vad som laddades vid körning.
- Felsökning — vattenmärken, avvisade licenser och funktionsfel.
Var den här sidan hjälpsam?