Lizenzsetup

Wo Doconut unter IIS nach Ihrer Lizenzdatei sucht

Ohne Lizenz rendert Doconut weiterhin Dokumente — jede Seite trägt lediglich ein Evaluierungs‑Wasserzeichen. Diese Seite behandelt die vier Möglichkeiten, eine Lizenz in Global.asax bereitzustellen, wo Doconut sucht, wenn Sie keine angeben, und was passiert, wenn die Lizenz eines Plugins fehlt.

Vier Möglichkeiten, eine Lizenz bereitzustellen

Es gibt drei explizite Quellen in DoconutOptions — einen Dateipfad, einen Stream oder rohen Inhalt — sowie die automatische Erkennung, wenn keine davon gesetzt ist. Alle werden einmal gelesen, in DoconutHost.Initialize. Wenn mehr als eine gesetzt ist, ist die Priorität exakt:

LicenseStream schlägt LicenseContent schlägt LicensePath schlägt automatische Erkennung.

Nach Pfad

Geben Sie LicensePath einen vollständigen Pfad. Ein relativer Pfad wird relativ zum aktuellen Verzeichnis des Prozesses aufgelöst, und unter IIS ist das der eigene Ordner des Worker‑Prozesses, nicht Ihre Website. HostingEnvironment.MapPath wandelt einen website‑relativen Pfad in einen vollständigen Pfad um:

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

Wenn die Datei nicht existiert, wirft Doconut keinen Fehler und fällt nicht auf die automatische Erkennung zurück: Es wird keine Lizenz geladen und der Betrachter versieht die Seiten mit Wasserzeichen. Die pro‑Plugin‑Lizenzdateien im selben Ordner (Doconut.Viewer.<Capability>.lic) werden zusammen damit gelesen, sodass LicensePath und AddPlugin<...>() zusammenarbeiten, wenn die Plugin‑Lizenzen neben der Basislizenz liegen.

Nach Stream

LicenseStream wird einmal beim Start gelesen — nützlich, wenn die Lizenz aus einer eingebetteten Ressource oder einem Geheimspeicher stammt, anstatt aus einer Datei auf der Festplatte.

csharp
// Priorität: LicenseStream > LicenseContent > LicensePath > Auto-Suche.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

Nach Inhalt

LicenseContent übernimmt den Lizenztext selbst — aus einer Umgebungsvariablen, einer Datenbank oder einem Geheimspeicher — sodass keine Lizenzdatei mit der Website bereitgestellt werden muss.

csharp
// Lizenz-XML aus einer Datenbank, einer Umgebungsvariable oder einem Geheimspeicher -
// keine Datei auf der Festplatte. Nur von LicenseStream übertroffen.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatische Erkennung

Setzen Sie keinen der drei, und Doconut sucht die Lizenz selbst:

csharp
// Nichts konfigurieren, und Doconut sucht die Lizenz selbst, in dieser Reihenfolge:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (unter IIS: das Stammverzeichnis der Website)
// Es sucht zuerst nach Doconut.lic; falls diese fehlt, Doconut.Viewer.lic sowie alle
// pro-Plugin Doconut.Viewer.<Capability>.lic-Dateien.
Doconut.DoconutHost.Initialize();

Die beiden Ordner, in dieser Reihenfolge, und die gesuchten Dateien:

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

Unter IIS und IIS Express ist AppContext.BaseDirectory der Stammordner der Website — derjenige, der Web.config enthält — nicht sein bin‑Ordner. Daher gehört die Lizenz in wwwroot im Stammverzeichnis der Website:

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

Im Projekt behalten Sie wwwroot\*.lic neben Web.config und stellen den Ordner mit der Website bereit. Kein Build‑Schritt muss sie irgendwohin kopieren. Ein .lic an anderer Stelle — in bin\, neben Web.config oder in einem Unterordner von wwwroot — wird niemals gelesen.

Halten Sie .lic‑Dateien außerhalb der Versionskontrolle. Stellen Sie sie zusammen mit der Website bereit oder liefern Sie die Lizenz über LicenseContent oder LicenseStream aus Ihrem Geheimspeicher.

Was passiert ohne Lizenz

Eine fehlende Lizenz wirft keinen Fehler. DoconutHost.Initialize gelingt, die Seite startet und der Viewer läuft, aber jede Seite trägt ein Evaluationswasserzeichen und keine optionalen Funktionen werden gewährt.

Eine gefundene, aber abgelehnte Lizenzdatei ist etwas anderes. Eine ungültige Signatur, Manipulation oder ein Build außerhalb des Versionsfensters der Lizenz lässt OpenDocumentAsync einen LicenseException mit dem Grund auslösen. Eine abgelaufene temporäre Lizenz läuft im wasserzeichen‑Modus weiter. Eine kostenpflichtige Lizenz, deren Abonnementdatum abgelaufen ist, funktioniert weiterhin, sauber und mit ihren Funktionen, bei jedem Build, der vor diesem Datum veröffentlicht wurde.

Plugins benötigen ihre Lizenz beim Start

Das Registrieren eines Plugins, dessen Fähigkeit von keiner Lizenz gewährt wird, stoppt die Anwendung beim Start. DoconutHost.Initialize wirft in 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.

Unter System.Web sehen Sie diese Meldung nicht im Browser. Jede Anfrage an die Seite beantwortet ein leeres 500 — keine Fehlerseite, kein Stack‑Trace, nichts im IIS‑Log. Die Ausnahme wird nur im Windows‑Ereignisprotokoll (Anwendungsprotokoll, Quelle ASP.NET) aufgezeichnet. Wenn die gesamte Seite sofort nach dem Hinzufügen einer AddPlugin‑Zeile nicht mehr reagiert, prüfen Sie die Lizenzdateien in wwwroot vor dem Code: Das Doconut.Viewer.<Capability>.lic des Plugins muss neben Doconut.Viewer.lic liegen, und ohne die Basislizenz werden die Plugin‑Dateien überhaupt nicht gelesen.

Überprüfen der geladenen Lizenz

IDoconutLicenseService ist dieselbe Quelle der Wahrheit, die das SDK verwendet. Lösen Sie es von DoconutHost.Services auf, um einen authentifizierten Diagnose‑Endpunkt bereitzustellen oder Feature‑Flags zu steuern — geben Sie niemals Lizenzinhalte zurück:

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

Die Lizenz wird einmal gelesen, in DoconutHost.Initialize. Nach dem Ersetzen einer Lizenzdatei den Anwendungspool neu starten (oder Web.config berühren), damit Application_Start erneut ausgeführt wird.

Fehlerbehebung

SymptomWahrscheinliche UrsachePrüfung
Viewer funktioniert, aber jede Seite ist wassergezeichnetKeine Lizenz gefundenBefindet sich das .lic in <site root>\wwwroot? Rufen Sie den Status‑Endpunkt oben auf
Jede Anfrage beantwortet ein leeres 500 unmittelbar nach dem Hinzufügen eines PluginsEin registriertes Plugin hat keine Lizenz, die es gewährtWindows‑Ereignisprotokoll, Quelle ASP.NET; das .lic des Plugins neben Doconut.Viewer.lic
LicensePath funktioniert auf Ihrem Rechner, aber nicht auf dem ServerEin relativer Pfad, der gegen den Worker‑Prozess‑Ordner aufgelöst wirdErstellen Sie es mit HostingEnvironment.MapPath("~/wwwroot/...")
Eine ersetzte .lic‑Datei hat keine WirkungDie Lizenz wurde beim Start der Anwendung gelesenStarten Sie den Anwendungspool neu
OpenDocumentAsync wirft LicenseExceptionDie Lizenz wurde gefunden, aber abgelehntLesen Sie die Ausnahme­nachricht; zeigen Sie sie nicht unzuverlässigen Clients

Nächste Schritte

  • Lizenzierung — Funktionen und wie man sie zur Laufzeit prüft.
  • Fehlerbehebung — Wasserzeichen, Startfehler und andere Symptome.

War diese Seite hilfreich?