Lizenzkonfiguration

Wo Doconut nach Ihrer Lizenzdatei sucht

Ohne Lizenz rendert Doconut weiterhin Dokumente — jede Seite trägt lediglich ein Evaluierungs‑Wasserzeichen. Diese Seite beschreibt die vier Möglichkeiten, eine Lizenz bereitzustellen, und die genaue Priorität, wenn mehr als eine gesetzt ist.

Die Lizenz wird einmal, während AddDoconut() geladen. Das ist eine Änderung gegenüber der vorherigen .NET Standard‑Bibliothek, bei der die Lizenz an eine Viewer‑Instanz übergeben oder über die statischen Aufrufe Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...) gesetzt wurde. Diese Methoden sind in dieser Version kein Start‑Mechanismus mehr — siehe den Migrationsleitfaden.

Vier Möglichkeiten, eine Lizenz bereitzustellen

Es gibt vier: drei explizite Quellen auf DoconutOptions — ein Stream, roher Inhalt oder ein Dateipfad — plus automatische Erkennung, wenn keine davon gesetzt ist. Wenn mehr als eine gesetzt ist, ist die Priorität exakt:

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

Nach Pfad

LicensePath wird exakt so an File.Exists übergeben. Ein relativer Pfad wird relativ zum aktuellen Arbeitsverzeichnis des Prozesses aufgelöst — nicht zu Ihrem Projektordner und nicht zu dem Ordner, in dem Program.cs liegt. Wenn der Pfad nicht aufgelöst werden kann, wirft Doconut keinen Fehler und greift nicht auf die automatische Suche zurück — es lädt einfach keine Lizenz und das Viewer‑Wasserzeichen wird angezeigt. Die automatische Suche wird nur ausgeführt, wenn weder LicensePath, LicenseContent noch LicenseStream gesetzt ist. Die pro‑Plugin‑Lizenzdateien im selben Ordner (Doconut.Viewer.<Capability>.lic) werden dabei gelesen, sodass LicensePath und AddPlugin<...>() zusammenarbeiten, wenn die Plugin‑Lizenzen neben der Basislizenz liegen.

Bevorzugen Sie einen absoluten Pfad (zum Beispiel erstellt aus IWebHostEnvironment.WebRootPath oder AppContext.BaseDirectory) oder überspringen Sie LicensePath vollständig und verlassen Sie sich auf die automatische Erkennung weiter unten.

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

Nach Stream

LicenseStream wird einmal beim Start gelesen — nützlich, wenn die Lizenz aus einem geheimen Speicher statt aus einer Datei auf der Festplatte stammt.

csharp
// Priorität: LicenseStream > LicenseContent > LicensePath > Auto‑Suche.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

Nach Inhalt

LicenseContent akzeptiert den Lizenztext selbst — aus einer Umgebungsvariablen, einer Datenbank oder einem Geheimnis‑Manager:

csharp
// Lizenz‑XML aus einer Datenbank, Umgebungsvariable oder Secret‑Manager —
// Keine Datei auf dem Datenträger. Nur von LicenseStream übertroffen.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Automatische Erkennung

Konfigurieren Sie keine der drei expliziten Quellen, und Doconut sucht die Lizenz selbst:

csharp
// Nichts konfigurieren, und Doconut sucht die Lizenz selbst, nur in diesen beiden Ordnern:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot im Build‑Ausgabeordner)
// Es sucht zuerst nach Doconut.lic; fehlt diese, nach Doconut.Viewer.lic sowie allen
// pro‑Fähigkeit Doconut.Viewer.<Capability>.lic‑Dateien.
builder.Services.AddDoconut();

Die zu durchsuchenden Ordner in der Reihenfolge sowie die gesuchten Dateinamen:

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

Nichts außerhalb eines wwwroot‑Ordners wird gelesen: ein .lic im Ausgabeverzeichnis selbst oder in wwwroot/lib wird ignoriert.

Wenn Sie zuvor ein List<string> mit Lizenzpfaden an den Viewer‑Konstruktor übergeben haben — einer pro Fähigkeit — behalten Sie diese Begleitdateien neben Doconut.Viewer.lic und lassen die automatische Erkennung sie aufnehmen. Es gibt keine Option für eine Pfadliste bei DoconutOptions.

Kopieren Sie die Lizenz in Ihren Ausgabeordner

Wenn der Prozess nicht aus dem Projektordner ausgeführt wird — eine veröffentlichte Anwendung, IIS, ein Container, ein Testlauf — verfehlt die erste Suche, und die zweite, {AppContext.BaseDirectory}/wwwroot, muss die Datei finden. Dieses MSBuild‑Ziel kopiert die Lizenzen bei jedem Build dorthin:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- Zuerst löschen, damit das Umbenennen oder Entfernen einer .lic in wwwroot sie auch aus der Ausgabe entfernt. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Der Zielort muss $(OutDir)wwwroot sein: ein .lic, das in das Ausgabeverzeichnis kopiert wird, wird von der automatischen Suche nie gefunden. Die LicensePath‑Beispiele auf dieser Seite verweisen auf denselben Ort.

Halten Sie .lic‑Dateien außerhalb der Versionskontrolle — stellen Sie sie zusammen mit der Anwendung bereit oder injizieren Sie die Lizenz über LicenseContent oder LicenseStream aus Ihrem Geheimspeicher.

Was passiert ohne Lizenz

Eine fehlende Lizenz löst keinen Fehler aus. AddDoconut() erfolgt erfolgreich, die Anwendung startet und der Viewer läuft — aber jede Seite trägt ein Evaluationswasserzeichen und es wird keine optionale Funktion gewährt.

Eine Lizenzdatei, die gefunden, aber abgelehnt wird, ist etwas anderes. Eine ungültige Signatur, Manipulation, Blacklisting oder ein Build außerhalb des Versionsfensters der Lizenz führt dazu, dass OpenDocumentAsync LicenseException mit License.RejectionMessage wirft. Eine abgelaufene temporäre Lizenz arbeitet weiter im wasserzeichen‑Modus. 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 Funktionen

Die Registrierung eines Plugins ohne entsprechende Berechtigung ist anders: Bei einer fehlenden Lizenz, einer veralteten TRIAL‑Datei oder einer kostenpflichtigen Lizenz ohne diese Funktion wirft AddDoconut() InvalidOperationException, sodass die Anwendung nicht startet. Zum Beispiel, die Registrierung des Converter‑Plugins ohne eine Lizenz, die Converter gewährt:

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.

Die Meldung gibt die Lösung direkt an: Entfernen Sie entweder den options.AddPlugin<...>()‑Aufruf für dieses Plugin oder installieren Sie eine kostenpflichtige Lizenz bzw. eine aktive temporäre/Demo‑(NFR‑)Lizenz, die die Funktion gewährt. Temporäre Registrierungen dürfen ihr Ablaufdatum überleben, sodass eine bereits konfigurierte Anwendung zur Laufzeit degradieren kann, anstatt beim Neustart abzustürzen; nach Ablauf bleiben ihre Funktionen dennoch entzogen.

Überprüfen Sie die geladene Lizenz

Verwenden Sie IDoconutLicenseService, dieselbe zuverlässige Quelle, die vom SDK genutzt wird, um einen authentifizierten Diagnose‑Endpunkt bereitzustellen oder Feature‑Flags zu steuern. Geben Sie keine Lizenzinhalte oder Schlüssel zurück.

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

Die Lizenz wird während der AddDoconut()‑Registrierung gelesen. ResetLicense ist derzeit eine Kompatibilitätseigenschaft ohne aktiven Neulade‑Pfad, daher erfordert das Ersetzen einer Lizenzdatei einen Neustart der Anwendung.

Fehlersuchmatrix

SymptomWahrscheinliche UrsachePrüfen
Viewer funktioniert, aber jede Seite ist mit einem Wasserzeichen versehenKeine Lizenz wurde geladen, oder die temporäre Lizenz ist abgelaufenLösen Sie IDoconutLicenseService; überprüfen Sie das Ausgabeverzeichnis und das Arbeitsverzeichnis des Prozesses
AddDoconut() wirft für ein PluginDie Lizenz gewährt diese Plugin‑Funktion nichtPrüfen Sie IsCapabilityGranted(...) und entfernen Sie Registrierungen, die Sie nicht erworben haben
Ein konfigurierter relativer Pfad funktioniert lokal, aber nicht in IIS/ContainerDas Arbeitsverzeichnis des Prozesses hat sich geändertVerwenden Sie AppContext.BaseDirectory oder einen absoluten Pfad
Ersetzte .lic‑Datei hat keine WirkungDer Singleton‑Lizenzservice war bereits erstelltStarten Sie die Anwendung neu
OpenDocumentAsync wirft LicenseExceptionSignatur, Domain, Versionsfenster, Blacklist oder Laufzeit‑Gate des Plugins hat die Lizenz abgelehntLesen Sie die Ausnahme‑/Ablehnungsnachricht, ohne sie unzuverlässigen Clients preiszugeben
Eine pro‑Funktion‑Lizenz funktionierte früher, aber jetzt nicht mehrDer alte Code übergab explizite Lizenzpfade an den Viewer‑KonstruktorVerschieben Sie die Begleit‑.lic‑Dateien neben Doconut.Viewer.lic und lassen Sie die automatische Erkennung sie laden

Nächste Schritte

  • Lizenzierung — Funktionen, Lizenzstufen und die Überprüfung, was zur Laufzeit geladen wurde.
  • Fehlerbehebung — Wasserzeichen, abgelehnte Lizenzen und Funktionsfehler.

War diese Seite hilfreich?