Installation

Fügen Sie Doconut zu Ihrem .NET 6-Projekt hinzu

Der Basis‑Doconut‑Viewer für .NET 6 wird als ein NuGet‑Paket geliefert, das sich in jede ASP.NET‑Core‑Anwendung einfügt. Optionale Plugins verwenden separate Pakete. Diese Seite installiert das Basis‑Paket und registriert die Middleware — das Minimum, das vor Ihrer ersten Darstellung benötigt wird.

Voraussetzungen

Die Pakete laufen auf diesen Plattformen:

PlattformUnterstützt
Windows x64 / x86Ja
Linux x64, glibc-basiert (Debian, Ubuntu, das offizielle mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim‑Image)Ja
Alpine und andere musl-basierte DistributionenNein
macOSNein

Unter Linux installieren Sie die Font‑Konfigurationsbibliothek, bevor das erste Dokument geöffnet wird:

bash
apt-get update && apt-get install -y libfontconfig1

Unter RHEL, Fedora und ähnlichen Distributionen ist das Paket fontconfig (dnf install -y fontconfig). Das ist das einzige Systempaket, das Doconut benötigt: Die nativen Bibliotheken, die es verwendet, werden im NuGet‑Paket mitgeliefert, und libgdiplus ist nicht erforderlich. In Docker bevorzugen Sie aspnet:6.0-bookworm-slim (Debian 12): Das Standard‑Tag aspnet:6.0 ist Debian 11, dessen Paketspiegel die Installation von libfontconfig1 fehlschlagen lassen können. Seiten werden mit den auf dem Server installierten Schriften gerendert, siehe Fehlerbehebung für Schriften und die Linux‑Fehlermeldungen.

Paket installieren

bash
dotnet add package Doconut.NET6

Der unveröffentlichte Befehl installiert die neueste stabile Version. Um die in dieser Dokumentation beschriebene Version festzulegen, übergeben Sie die Version als separate Option:

bash
dotnet add package Doconut.NET6 --version 26.10.0

Doconut.NET6 ist die Paket‑ID. Das Versionssuffix gehört zum heruntergeladenen Doconut.NET6.<version>.nupkg Dateinamen und ist nicht Teil der ID.

Identifizieren Sie die Integration vor dem Upgrade

Die Doconut.NET6 Paket‑ID wurde sowohl von der klassischen als auch der aktuellen .NET 6‑Integration verwendet. Wählen Sie die Dokumentation nicht nur anhand des Paketnamens aus:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), synchron OpenDocument(...) und manuell kopierte Viewer‑Skripte identifizieren die klassische Integration;
  • AddDoconut(), UseDoconutResources(), ein injizierter Viewer und OpenDocumentAsync(...) identifizieren die aktuelle, hier dokumentierte Integration.

Das übersetzte klassische Einrichtungs‑Handbuch ist weiterhin verfügbar. Verwenden Sie den Migrationsleitfaden, um Generationen zu ändern; ein normales Paket‑Update konvertiert Startup, Viewer‑Lebensdauer oder Browser‑Ressourcen nicht automatisch.

Doconut registrieren

AddDoconut() ist der einzige Registrierungs‑Einstiegspunkt — es gibt nur eine Überladung, und sie verbindet den Viewer‑Dienst, den Lizenz‑Dienst und die Rendering‑Infrastruktur in den DI‑Container.

Zwei Middleware‑Aufrufe vervollständigen die Einrichtung, und ihre Reihenfolge ist wichtig: UseDoconutResources() muss vor UseDoconut() ausgeführt werden. UseDoconut() ist terminale Middleware, sodass ein Aufruf zuerst bedeutet, dass jede Anfrage an ein /doconut-res‑Asset nie den Ressourcen‑Handler erreicht und 404‑Fehler erzeugt. UseDoconut() beantwortet jede Anfrage, die ihn erreicht, daher sollten Sie ihn in einem eigenen Zweig mit app.Map einbinden. Das Session‑Wiring ist ebenfalls erforderlich — Doconut's Standard‑Dokumentensicherheit prüft jede Seitenanfrage gegen den ASP.NET‑Session‑State.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // Sitzungszustand benötigt einen Cache (MVC/Razor Pages fügen bereits einen hinzu)
builder.Services.AddSession(); // Doconut-Dokumentsicherheit beruht auf dem ASP.NET-Sitzungszustand

app.UseSession();          // Rufen Sie UseSession() vor UseDoconut() auf
app.UseDoconutResources(); // Muss vor UseDoconut() registriert werden
app.Map("/doconut", branch => branch.UseDoconut());

Alle Optionen

DoconutOptions akzeptiert die folgenden einstellbaren Eigenschaften. Jede ist optional — die untenstehenden Vorgaben gelten, wenn eine Eigenschaft nicht gesetzt wird.

EigenschaftStandardBeschreibung
ShowDoconutInfofalseWenn true, gibt eine Anfrage ohne token stattdessen ein Versionsbanner zurück anstelle eines 404. Nützlich als Schnelltest; in der Produktion deaktivieren.
UnsafeModefalseWenn true, wird die ASP.NET‑Session‑Sicherheitsprüfung bei Seitenanfragen übersprungen. In der Produktion deaktivieren.
MiddlewarePath"/doconut"Koordinationswert für den page‑image‑Endpunkt. Er wird validiert, mountet jedoch keinen eigenen Zweig; halten Sie ihn abgestimmt mit der tatsächlichen UseDoconut()‑Zuordnung und dem Client‑BasePath.
ResourcesPath"/doconut-res"Wo die eingebetteten JS/CSS/Image‑Ressourcen bereitgestellt werden.
LicensePath"" (empty string)Pfad zur Lizenzdatei. Leer bedeutet, dass zur nächsten Quelle weitergegangen wird, dann automatische Suche.
LicenseContent"" (empty string)Roh‑Lizenzinhalt — aus einer Umgebungsvariablen, einem Geheimnis‑Manager oder einer Datenbank.
LicenseStreamnullLizenz als Stream, einmal beim Start gelesen.
ResetLicensefalseReserviertes Kompatibilitäts‑Flag. Die aktuellen .NET 6‑Dienste lesen die Lizenz während AddDoconut(); starten Sie die Anwendung neu, nachdem Sie eine Lizenz ausgetauscht haben.
MaxConcurrentEditorSessions200Maximale Anzahl gleichzeitiger Editor‑Sitzungen (Dokumente, die mit DocOptions.EditMode geöffnet wurden). Darüber hinaus wird die am wenigsten kürzlich genutzte inaktive Editor‑Sitzung geschlossen. Normale Viewer‑Sitzungen werden nie gezählt. 0 oder ein negativer Wert bedeutet keine Begrenzung.
EditorSnapshotEveryOps50Bei aktivierter Editor‑Persistenz (AddDoconutEditorPersistence) wird das Live‑Dokument alle N aufgezeichneten Änderungen snapshotten. 0 oder ein negativer Wert erzeugt nie Snapshots während einer Sitzung. Keine Wirkung, wenn die Persistenz deaktiviert ist.

Lizenz‑Priorität, wenn mehr als eine Quelle gesetzt ist: LicenseStream hat Vorrang vor LicenseContent, vor LicensePath und vor der automatischen Suche — siehe Lizenz‑Einrichtung.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // Koordinieren Sie die App-Mapping und den Client-BasePath
    options.ResourcesPath   = "/doconut-res"; // Wo die JS/CSS/Bilder des Viewers bereitgestellt werden
    options.UnsafeMode      = false;          // Sitzungssicherheit aktiv lassen
    options.ShowDoconutInfo = false;
});

Nächste Schritte

War diese Seite hilfreich?