Licensinställning

Var Doconut letar efter din licensfil under IIS

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 i Global.asax, var Doconut letar när du inte anger någon, och vad som händer när ett plugins licens saknas.

Fyra sätt att tillhandahålla en licens

Det finns tre explicita källor på DoconutOptions — en filsökväg, en ström eller rått innehåll — plus automatisk upptäckt när ingen av dem är angiven. Alla läses en gång, i DoconutHost.Initialize. När mer än en är angiven är prioriteringen exakt:

LicenseStream slår LicenseContent slår LicensePath slår automatisk upptäckt.

Via sökväg

Ge LicensePath en fullständig sökväg. En relativ sökväg löses upp mot processens aktuella katalog, och under IIS är det arbetsprocessens egen mapp, inte din webbplats. HostingEnvironment.MapPath omvandlar en webbplatsrelativ sökväg till en fullständig:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});

Om filen inte finns kastar Doconut inte ett undantag och faller inte tillbaka på automatisk upptäckt: den laddar ingen licens, och visaren vattenstämplar. 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 huvudlicensen.

Via ström

LicenseStream läses en gång, vid uppstart — användbart när licensen kommer från en inbäddad resurs eller en hemlig lagring snarare än en fil på disk.

csharp
// Prioritet: LicenseStream > LicenseContent > LicensePath > auto-sökning.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Via innehåll

LicenseContent tar själva licenstexten — från en miljövariabel, en databas eller en hemlig lagring — så ingen licensfil behöver distribueras med webbplatsen.

csharp
// License XML från en databas, en miljövariabel eller en hemlig lagring -
// Ingen fil på disk. Överträffas bara av LicenseStream.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatisk upptäckt

Ställ in ingen av de tre, så söker Doconut efter licensen själv:

csharp
// Konfigurera ingenting, och Doconut söker efter licensen själv, i följande ordning:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (under IIS: webbplatsens rotmapp)
// Den letar först efter Doconut.lic; om den saknas, Doconut.Viewer.lic plus eventuella
// per-plugin Doconut.Viewer.<Capability>.lic-filer.
Doconut.DoconutHost.Initialize();

De två mapparna, i ordning, och filerna som söks 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-plugin licenses, read only when Doconut.Viewer.lic was found

Under IIS och IIS Express är AppContext.BaseDirectory webbplatsens rotmapp — den som innehåller Web.config — inte dess bin-mapp. Så licensen ska ligga i wwwroot under webbplatsens rot:

text
MySite\
  Web.config
  Global.asax
  bin\
  wwwroot\
    Doconut.Viewer.lic
    Doconut.Viewer.Converter.lic

I projektet, håll wwwroot\*.lic bredvid Web.config och distribuera mappen med webbplatsen. Inget byggsteg behöver kopiera den någonstans. En .lic någon annanstans — i bin\, bredvid Web.config, eller i en undermapp till wwwroot — läses aldrig.

Håll .lic-filer utanför källkontrollen. Distribuera dem tillsammans med webbplatsen, eller tillhandahåll licensen via LicenseContent eller LicenseStream från din hemliga lagring.

Vad händer utan en licens

En saknad licens kastar inte ett undantag. DoconutHost.Initialize lyckas, webbplatsen startar och visaren körs, 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 eller en byggnad utanför licensens versionsfönster får OpenDocumentAsync att kasta LicenseException med orsaken. 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 sin licens vid start

Att registrera ett plugin vars funktion ingen licens beviljar stoppar applikationen vid start. DoconutHost.Initialize kastar i Application_Start:

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.

Under System.Web ser du inte det meddelandet i webbläsaren. Varje begäran till webbplatsen svarar med en tom 500 — ingen felsida, ingen stack‑spårning, inget i IIS‑loggen. Undantaget registreras endast i Windows‑händelseloggen (Applikationslogg, källa ASP.NET). Om hela webbplatsen slutar svara precis efter att du lagt till en AddPlugin‑rad, kontrollera licensfilerna i wwwroot innan koden: plugin‑Doconut.Viewer.<Capability>.lic måste ligga bredvid Doconut.Viewer.lic, och utan grundlicensen läses plugin‑filerna inte alls.

Verifiera den laddade licensen

IDoconutLicenseService är samma sanningskälla som SDK:n använder. Hämta den från DoconutHost.Services för att exponera en autentiserad diagnostik‑endpoint eller styra funktionsflaggor — returnera aldrig licensinnehåll:

csharp
// GET /License/Status
public ActionResult Status()
{
    var license = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(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
    }, JsonRequestBehavior.AllowGet);
}

Licensen läses en gång, i DoconutHost.Initialize. Efter att ha ersatt en licensfil, återställ applikationspoolen (eller rör Web.config) så att Application_Start körs igen.

Felsökning

SymptomTrolig orsakKontroll
Visaren fungerar men varje sida är vattenstämpladIngen licens hittadesÄr .lic i <site root>\wwwroot? Anropa status‑endpointen ovan
Varje begäran svarar med en tom 500 precis efter att ha lagt till ett pluginEtt registrerat plugin har ingen licens som beviljar detWindows‑händelseloggen, källa ASP.NET; plugin‑.lic bredvid Doconut.Viewer.lic
LicensePath fungerar på din maskin men inte på servernEn relativ sökväg som löses mot arbetsprocessens mappBygg den med HostingEnvironment.MapPath("~/wwwroot/...")
En ersatt .lic‑fil har ingen effektLicensen lästes när applikationen startadeÅterställ applikationspoolen
OpenDocumentAsync kastar LicenseExceptionLicensen hittades men avvisadesLäs undantagsmeddelandet; visa det inte för opålitliga klienter

Nästa steg

  • Licensiering — funktioner, och hur man kontrollerar dem vid körning.
  • Felsökning — vattenstämplar, startfel och andra symptom.

Var den här sidan hjälpsam?