Installation

Lägg till Doconut i ditt .NET Standard 2.1-projekt

Den grundläggande Doconut‑visaren för .NET Standard levereras som ett NuGet‑paket som kan anslutas till vilken ASP.NET Core‑applikation som helst. Valfria tillägg använder separata paket. Denna sida installerar grundpaketet, bekräftar att din värd kan konsumera det och registrerar middleware — det minsta som behövs innan din första rendering.

Kontrollera värdens ramverk först

Biblioteket riktar sig mot netstandard2.1. Det är ett snävare kontrakt än den tidigare netstandard2.0‑byggnaden, och det är det första som bör verifieras:

VärdStöds
.NET Core 3.0 eller senare, inklusive .NET 5/6/7/8Ja
.NET Framework (valfri version)Nej — netstandard2.1 kan inte konsumeras av .NET Framework

Om applikationen körs på .NET Framework är detta inte rätt paket. Använd Doconut.NETFramework istället; från 26.9.0 kräver det .NET Framework 4.7.2. Referensapplikationerna som levereras med denna release riktar sig mot net8.0.

Installera paketet

bash
dotnet add package Doconut.NETStandard

Det oversionsspecifika kommandot installerar den senaste stabila releasen. För att reproducera den aktuella 26.8.0‑releasen exakt, ange versionen som ett separat alternativ:

bash
dotnet add package Doconut.NETStandard --version 26.8.0

Doconut.NETStandard är paket‑ID. Suffixet .26.8.0 tillhör den nedladdade filen Doconut.NETStandard.26.8.0.nupkg och är inte en del av ID‑t.

Versionsnumret är generationen

Detta är viktigare här än paketnamnet. Båda generationerna av .NET Standard‑biblioteket publiceras under samma paket‑ID, och endast versionen skiljer dem åt:

VersionMålAPI
26.7.0 och lägrenetstandard2.0den tidigare integrationen
26.8.0 och högrenetstandard2.1integrationen som dokumenteras här

Det finns ingen kompatibilitetsshim och inget sid‑vid‑sid‑paket. Att höja versionen är uppgraderingen, och kompilatorn kommer omedelbart att rapportera API‑skillnaderna.

Välj inte dokumentation enbart baserat på paketnamnet:

  • new Viewer(_cache, _accessor, …), UnSafeMode, synkron OpenDocument(...), viewer.InitCache(), UseDoconutWebFarm och manuellt kopierade visarskript identifierar den tidigare integrationen;
  • AddDoconut(), UseDoconutResources(), en injicerad Viewer och OpenDocumentAsync(...) identifierar den nuvarande integrationen som dokumenteras här.

Den översatta tidigare installationsmanualen finns fortfarande tillgänglig. Använd migrationsguiden för att byta generation; en paketuppdatering konverterar inte automatiskt start‑upp, visarlivslängd eller webbläsarresurser.

Registrera Doconut

AddDoconut() är den enda registreringspunkten — det finns bara en överlagring, och den kopplar Viewer‑tjänsten, licenstjänsten och renderingsinfrastrukturen till DI‑behållaren.

Två middleware‑anrop slutför installationen, och deras ordning är viktig: UseDoconutResources() måste köras före UseDoconut(). UseDoconut() är terminal middleware, så om den anropas först når ingen förfrågan en /doconut-res‑resurs och svarar med 404. Sessionskopplingen krävs också — Doconut:s standarddokument‑säkerhet validerar varje sidförfrågan mot ASP.NET‑sessionsstatus.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // sessionsstatus behöver en cache (MVC/Razor Pages lägger redan till en)
builder.Services.AddSession(); // Doconut-dokumentsäkerhet bygger på ASP.NET sessionsstatus

app.UseSession();          // anropa UseSession() före UseDoconut()
app.UseDoconutResources(); // måste registreras före UseDoconut()
app.UseDoconut();

Namnrymder

Konfigurationstyperna är inte längre spridda över fyra namnrymder. I denna release lever nästan allt i rot‑namnrymden Doconut:

csharp
using Doconut;                       // Viewer, DoconutOptions, DocOptions, all format configs
using Doconut.Middleware;            // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds;                // cloud and file-share configs
using Doconut.Configs.Conversion;    // ConversionTarget

Typnamnen i sig har inte förändrats — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig och resten finns fortfarande. Om du flyttar en befintlig applikation krävs i de flesta filer bara två borttagna using‑rader; se migrationsguiden.

Alla alternativ

DoconutOptions accepterar följande inställningsbara egenskaper. Alla är valfria — standardvärdena nedan gäller när en egenskap lämnas odefinierad.

EgenskapStandardBeskrivning
ShowDoconutInfofalseNär true returneras en versionsbanner istället för 404 för en förfrågan utan token. Användbart som en snabbkontroll; inaktivera i produktion.
UnsafeModefalseNär true hoppas ASP.NET‑sessionssäkerhetskontrollen över vid sidförfrågningar. Inaktivera i produktion. Notera stavningen — det tidigare biblioteket kallade detta UnSafeMode.
MiddlewarePath"/doconut"Koordinationsvärde för slutpunkten för sid‑bild. Det valideras, men monterar inte en gren av sig själv; håll det i linje med den faktiska UseDoconut()‑mappningen och klientens BasePath.
ResourcesPath"/doconut-res"Var de inbäddade JS/CSS/bild‑resurserna serveras från.
LicensePath"" (tom sträng)Sökväg till licensfilen. Tom betyder att nästa källa provas, sedan autosökning.
LicenseContent"" (tom sträng)Rå licensinnehåll — från en miljövariabel, en hemlighets‑hanterare eller en databas.
LicenseStreamnullLicens som en ström, läses en gång vid start.
ResetLicensefalseReserverad kompatibilitetsflagga. Licensen läses under AddDoconut(); starta om appen efter att ha ersatt en licens.

Licens‑prioritet när mer än en källa är angiven: LicenseStream slår LicenseContent som slår LicensePath som slår autosökning — se License Setup.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // koordinera med appens mappning och klientens BasePath
    options.ResourcesPath   = "/doconut-res"; // var visarens JS/CSS/bilder serveras från
    options.UnsafeMode      = false;          // behåll sessionsäkerhet på
    options.ShowDoconutInfo = false;
});

Nästa steg

Var den här sidan hjälpsam?