Installation

Lägg till Doconut i ditt .NET 8-projekt

Den grundläggande Doconut-visaren för .NET 8 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:

PlattformStöds
Windows x64 / x86Ja
Linux x64, glibc-baserad (Debian, Ubuntu, den officiella mcr.microsoft.com/dotnet/aspnet:8.0 bilden)Ja
Alpine och andra musl-baserade distributionerNej
macOSNej

På Linux, installera fontkonfigurationsbiblioteket innan det första dokumentet öppnas:

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

På RHEL, Fedora och liknande distributioner är paketet fontconfig (dnf install -y fontconfig). Det är det enda systempaketet som Doconut behöver: de inbyggda biblioteken den använder levereras i NuGet-paketet, och libgdiplus krävs inte. Sidor ritas med de teckensnitt som är installerade på servern, så se Felsökning för teckensnitt och Linux-felmeddelanden.

Installera paketet

bash
dotnet add package Doconut.NET8

Det oversionsstyrda kommandot installerar den senaste stabila versionen. För att låsa den version som denna dokumentation beskriver, ange versionen som ett separat alternativ:

bash
dotnet add package Doconut.NET8 --version 26.10.0

Doconut.NET8 är paket-ID:t. Versionssuffixet tillhör den nedladdade Doconut.NET8.<version>.nupkg filnamnet och är inte en del av ID:t.

Registrera Doconut

AddDoconut() är den enda registreringsingångspunkten — det finns ett enda överlagringsalternativ, 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 resurshanteraren och får 404. UseDoconut() svarar på varje begäran som når den, så montera den på sin egen gren med app.Map. Sessionskopplingen krävs också — Doco nuts standarddokumentsäkerhet validerar varje sidbegäran mot ASP.NET-sessionsstatus.

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

app.UseSession();          // anropa UseSession() innan UseDoconut()
app.UseDoconutResources(); // måste registreras innan UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Alla alternativ

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

EgenskapStandardBeskrivning
ShowDoconutInfofalseNär true, returnerar en begäran utan token en versionsbanner istället för en 404. Användbart som en snabbkontroll; inaktivera i produktion.
UnsafeModefalseNä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 klientens BasePath.
ResourcesPath"/doconut-res"Var de inbäddade JS/CSS/image-resurserna serveras från.
LicensePath"" (empty string)Sökväg till licensfilen. Tomt betyder att man faller tillbaka till nästa källa, sedan autosökning.
LicenseContent"" (empty string)Rå licensinnehåll — från en miljövariabel, en hemlighets‑hanterare eller en databas.
LicenseStreamnullLicens som en ström, läst en gång vid start.
ResetLicensefalseReserverad kompatibilitetsflagga. De aktuella .NET 8-tjänsterna läser licensen under AddDoconut(); starta om appen efter att ha ersatt en licens.
MaxConcurrentEditorSessions200Maximalt antal aktiva redigeringssessioner (dokument öppnade med DocOptions.EditMode). Överst stängs den minst nyligen använda inaktiva redigeringssessionen. Normala visningssessioner räknas aldrig. 0 eller ett negativt värde betyder ingen gräns.
EditorSnapshotEveryOps50Med redigerarpersistens aktiverad (AddDoconutEditorPersistence), ta en ögonblicksbild av det levande dokumentet var N:te registrerade ändring. 0 eller ett negativt värde tar aldrig ögonblicksbilder under 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.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // koordinera med app-mappning och klientens BasePath
    options.ResourcesPath   = "/doconut-res"; // var visningsprogrammets JS/CSS/images serveras från
    options.UnsafeMode      = false;          // behåll sessionssä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?