Installation
Lägg till Doconut i ditt .NET 6-projekt
Den grundläggande Doconut-visaren för .NET 6 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 och registrerar middleware — det minsta som behövs innan din första rendering.
Krav
Paketet körs på följande plattformar:
| Plattform | Stöds |
|---|---|
| Windows x64 / x86 | Ja |
Linux x64, glibc-baserad (Debian, Ubuntu, den officiella mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim avbildning) | Ja |
| Alpine och andra musl-baserade distributioner | Nej |
| macOS | Nej |
På Linux, installera fontkonfigurationsbiblioteket innan det första dokumentet öppnas:
apt-get update && apt-get install -y libfontconfig1På RHEL, Fedora och liknande distributioner är paketet fontconfig (dnf install -y fontconfig). Det är det enda systempaketet Doconut behöver: de inbyggda biblioteken den använder levereras i NuGet-paketet, och libgdiplus krävs inte. I Docker, föredra aspnet:6.0-bookworm-slim (Debian 12): standard‑taggen aspnet:6.0 är Debian 11, vars paket‑spegel kan misslyckas med att installera libfontconfig1. Sidor ritas med de teckensnitt som är installerade på servern, så se Felsökning för teckensnitt och Linux‑felmeddelanden.
Installera paketet
dotnet add package Doconut.NET6Det oversionsstyrda kommandot installerar den senaste stabila versionen. För att låsa den version som denna dokumentation beskriver, ange versionen som ett separat alternativ:
dotnet add package Doconut.NET6 --version 26.10.0Doconut.NET6 är paket‑ID:t. Versionssuffixet tillhör den nedladdade Doconut.NET6.<version>.nupkg filnamnet och är inte en del av ID:t.
Identifiera integrationen innan uppgradering
Doconut.NET6 paket‑ID har använts både av den klassiska och den nuvarande .NET 6‑integrationen. Välj inte dokumentation enbart baserat på paketnamnet:
DocImage.axd,new Viewer(_cache, _accessor, ...), synkronOpenDocument(...), och manuellt kopierade visarskript identifierar den klassiska integrationen;AddDoconut(),UseDoconutResources(), en injiceradViewer, ochOpenDocumentAsync(...)identifierar den nuvarande integrationen som dokumenteras här.
Den översatta klassiska installationsmanualen finns fortfarande tillgänglig. Använd migrationsguiden för att byta generationer; en normal paketuppdatering konverterar inte start, visarlivstid eller webbläsarresurser automatiskt.
Registrera Doconut
AddDoconut() är den enda registreringsingångspunkten — det finns en enda överlagring, och den kopplar Viewer‑tjänsten, licenstjänsten och renderingsinfrastrukturen till DI‑behållaren.
Två middleware‑anrop slutför konfigurationen, och deras ordning är viktig: UseDoconutResources() måste köras före UseDoconut(). UseDoconut() är terminal middleware, så att anropa den först innebär att varje begäran till en /doconut-res‑resurs aldrig når resurs‑hanteraren och ger 404. UseDoconut() svarar på varje begäran som når den, så montera den på en egen gren med app.Map. Sessionskopplingen krävs också — Doconuts standarddokument‑säkerhet validerar varje sidbegäran mot ASP.NET‑sessionsstatus.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // sessionstillstånd behöver en cache (MVC/Razor Pages lägger redan till en)
builder.Services.AddSession(); // Doconut dokumentsäkerhet bygger på ASP.NET sessionstillstånd
app.UseSession(); // anropa UseSession() före UseDoconut()
app.UseDoconutResources(); // måste registreras före UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());Alla alternativ
DoconutOptions accepterar följande konfigurerbara egenskaper. Alla är valfria — standardvärdena nedan gäller när en egenskap lämnas odefinierad.
| Egenskap | Standard | Beskrivning |
|---|---|---|
ShowDoconutInfo | false | När true, returnerar en begäran utan token en versionsbanner istället för en 404. Användbart som en snabbkontroll; inaktivera i produktion. |
UnsafeMode | false | När true, hoppar över ASP.NET‑sessionssäkerhetskontrollen på sidbegäranden. Inaktivera i produktion. |
MiddlewarePath | "/doconut" | Koordinationsvärde för slutpunkten page-image. Det valideras, men monterar inte en gren i sig självt; håll det i linje med den faktiska UseDoconut()‑mappningen och klient‑BasePath. |
ResourcesPath | "/doconut-res" | Var de inbäddade JS/CSS/image‑resurserna serveras från. |
LicensePath | "" (tom sträng) | Sökväg till licensfilen. Tom betyder att man faller tillbaka till nästa källa, sedan autosökning. |
LicenseContent | "" (tom sträng) | Rå licensinnehåll — från en miljövariabel, en hemlighets‑hanterare eller en databas. |
LicenseStream | null | Licens som en ström, läses en gång vid start. |
ResetLicense | false | Reserverad kompatibilitetsflagga. De aktuella .NET 6‑tjänsterna läser licensen under AddDoconut(); starta om appen efter att ha ersatt en licens. |
MaxConcurrentEditorSessions | 200 | Maximalt antal aktiva redigeringssessioner (dokument öppnade med DocOptions.EditMode). Överst stängs den minst nyligen använda inaktiva redigeringssessionen. Normala visarsessioner räknas aldrig. 0 eller ett negativt värde betyder ingen gräns. |
EditorSnapshotEveryOps | 50 | Med redigerarpersistens aktiverad (AddDoconutEditorPersistence), tas en ögonblicksbild av det levande dokumentet var N:te registrerad förändring. 0 eller ett negativt värde tar aldrig ögonblicksbilder mitt i en session. Ingen effekt när persistens är inaktiverad. |
Licensprioritet när mer än en källa är angiven: LicenseStream har företräde framför LicenseContent, som har företräde framför LicensePath, som har företräde framför autosökning — se Licensinställning.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.MiddlewarePath = "/doconut"; // koordinera med app-mappning och klient-BasePath
options.ResourcesPath = "/doconut-res"; // varifrån viewerns JS/CSS/bilder serveras
options.UnsafeMode = false; // behåll sessionsäkerhet på
options.ShowDoconutInfo = false;
});Nästa steg
- Snabbstart — öppna ditt första dokument och rendera det i webbläsaren.
- Licensinställning — där Doconut söker efter din licensfil.
Var den här sidan hjälpsam?