Instalace

Přidejte Doconut do svého projektu .NET 8

Základní prohlížeč Doconut pro .NET 8 je distribuován jako jeden balíček NuGet, který se připojí k libovolné aplikaci ASP.NET Core. Volitelné pluginy používají samostatné balíčky. Tato stránka nainstaluje základní balíček a zaregistruje middleware — minimum potřebné před vaším prvním vykreslením.

Požadavky

Balíček běží na těchto platformách:

PlatformaPodporováno
Windows x64 / x86Ano
Linux x64, založený na glibc (Debian, Ubuntu, oficiální mcr.microsoft.com/dotnet/aspnet:8.0 obraz)Ano
Alpine a další distribuce založené na muslNe
macOSNe

Na Linuxu nainstalujte knihovnu pro konfiguraci fontů před otevřením prvního dokumentu:

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

Na distribucích RHEL, Fedora a podobných je balíček fontconfig (dnf install -y fontconfig). To je jediný systémový balíček, který Doconut potřebuje: nativní knihovny, které používá, jsou součástí balíčku NuGet, a libgdiplus není vyžadován. Stránky jsou vykreslovány pomocí fontů nainstalovaných na serveru, takže se podívejte na Řešení problémů ohledně fontů a chybových zpráv Linuxu.

Instalace balíčku

bash
dotnet add package Doconut.NET8

Příkaz bez verze nainstaluje nejnovější stabilní vydání. Pro připnutí verze, kterou tato dokumentace popisuje, předávejte verzi jako samostatnou možnost:

bash
dotnet add package Doconut.NET8 --version 26.10.0

Doconut.NET8 je ID balíčku. Přípona verze patří ke staženému souboru Doconut.NET8.<version>.nupkg a není součástí ID.

Registrace Doconut

AddDoconut() je jediný vstupní bod registrace — existuje jediný přetížení a propojuje službu Viewer, licenční službu a renderovací infrastrukturu do kontejneru DI.

Dvě volání middleware dokončují nastavení a jejich pořadí je důležité: UseDoconutResources() musí běžet před UseDoconut(). UseDoconut() je terminální middleware, takže jeho první volání znamená, že každý požadavek na asset /doconut-res nikdy nedosáhne obsluhy zdrojů a vrátí 404. UseDoconut() odpovídá na každý požadavek, který k němu dorazí, takže jej připojte na vlastní větev pomocí app.Map. Propojení sezení je také vyžadováno — výchozí zabezpečení dokumentu Doconut ověřuje každý požadavek stránky vůči stavu sezení ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // stav relace potřebuje mezipaměť (MVC/Razor Pages již přidávají jednu)
builder.Services.AddSession(); // Bezpečnost dokumentu Doconut je postavena na ASP.NET session state

app.UseSession();          // zavolejte UseSession() před UseDoconut()
app.UseDoconutResources(); // musí být zaregistrováno před UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Všechny možnosti

DoconutOptions přijímá následující nastavitelná vlastnosti. Každá je volitelná — výchozí hodnoty níže platí, pokud je vlastnost ponechána nenastavena.

VlastnostVýchozíPopis
ShowDoconutInfofalseKdyž true, požadavek bez token vrátí banner verze místo 404. Užitečné jako rychlá kontrola; v produkci vypněte.
UnsafeModefalseKdyž true, přeskočí kontrolu zabezpečení ASP.NET-session u požadavků na stránky. V produkci vypněte.
MiddlewarePath"/doconut"Koordinační hodnota pro endpoint page-image. Je validována, ale sama o sobě nevytváří větev; udržujte ji v souladu se skutečným mapováním UseDoconut() a klientským BasePath.
ResourcesPath"/doconut-res"Odkud jsou poskytovány vložené zdroje JS/CSS/image.
LicensePath"" (empty string)Cesta k souboru licence. Prázdná hodnota znamená přechod na další zdroj, pak automatické hledání.
LicenseContent"" (empty string)Surový obsah licence — z proměnné prostředí, správce tajemství nebo databáze.
LicenseStreamnullLicence jako stream, načtená jednou při spuštění.
ResetLicensefalseRezervovaný příznak kompatibility. Aktuální služby .NET 8 čtou licenci během AddDoconut(); po výměně licence restartujte aplikaci.
MaxConcurrentEditorSessions200Maximální počet živých editorových sezení (dokumenty otevřené pomocí DocOptions.EditMode). Nad tuto hodnotu je nejméně nedávno použité nečinné editorové sezení uzavřeno. Normální prohlížečová sezení se nepočítají. 0 nebo záporná hodnota znamená žádný limit.
EditorSnapshotEveryOps50Při povolené perzistenci editoru (AddDoconutEditorPersistence) pořizujte snímek živého dokumentu po každých N zaznamenaných změnách. 0 nebo záporná hodnota nikdy nepořizuje snímky během sezení. Nemá žádný vliv, když je perzistence vypnuta.

Priorita licence, když je nastaveno více zdrojů: LicenseStream má přednost před LicenseContent, před LicensePath a před automatickým hledáním — viz Nastavení licence.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // koordinujte s mapováním aplikace a BasePath klienta
    options.ResourcesPath   = "/doconut-res"; // odkud jsou servírovány JS/CSS/images prohlížeče
    options.UnsafeMode      = false;          // udržujte bezpečnost relace
    options.ShowDoconutInfo = false;
});

Další kroky

Byla tato stránka užitečná?