Instalace

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

Základní prohlížeč Doconut pro .NET 6 je distribuován jako jeden balíček NuGet, který se zapojuje do libovolné aplikace ASP.NET Core. Volitelné pluginy používají samostatné balíčky. Tato stránka nainstaluje základní balíček a zaregistruje middleware — minimální požadavek před vaším prvním vykreslením.

Požadavky

PlatformaPodporováno
Windows x64 / x86Ano
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim image)Ano
Alpine and other musl-based distributionsNe
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.
V Dockeru upřednostněte aspnet:6.0-bookworm-slim (Debian 12): výchozí tag aspnet:6.0 je Debian 11, jehož zrcadla balíčků mohou selhat při instalaci libfontconfig1. Stránky jsou vykreslovány s fonty nainstalovanými na serveru, proto se podívejte na Řešení problémů ohledně fontů a chybových zpráv Linuxu.

Instalace balíčku

bash
dotnet add package Doconut.NET6

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

bash
dotnet add package Doconut.NET6 --version 26.10.0

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

Identifikujte integraci před aktualizací

ID balíčku Doconut.NET6 bylo použito jak pro klasickou, tak pro současnou integraci .NET 6. Nevybírejte dokumentaci pouze podle názvu balíčku:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), synchronní OpenDocument(...), a ručně zkopírované skripty prohlížeče identifikují klasickou integraci;
  • AddDoconut(), UseDoconutResources(), injektovaný Viewer, a OpenDocumentAsync(...) identifikují současnou integraci dokumentovanou zde.

Přeložený klasický průvodce nastavením je nadále k dispozici. Použijte průvodce migrací k změně generací; běžná aktualizace balíčku automaticky nepřevádí start, životnost prohlížeče ani zdroje prohlížeče.

Zaregistrujte 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 volání jako první způsobí, že každý požadavek na aktivum /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 s app.Map. Propojení sezení je také vyžadováno — výchozí zabezpečení dokumentu Doconut ověřuje každý požadavek stránky proti stavu ASP.NET sezení.

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 dokumentů Doconut je postavena na ASP.NET session state

app.UseSession();          // volání 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 sezení u požadavků na stránky. V produkci vypněte.
MiddlewarePath"/doconut"Koordinační hodnota pro koncový bod 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/obrázky.
LicensePath"" (empty string)Cesta k licenčnímu souboru. Prázdná hodnota znamená přechod na další zdroj, poté 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 startu.
ResetLicensefalseRezervovaný příznak kompatibility. Současné služby .NET 6 čtou licenci během AddDoconut(); po výměně licence restartujte aplikaci.
MaxConcurrentEditorSessions200Maximální počet aktivních relací editoru (dokumenty otevřené pomocí DocOptions.EditMode). Při překročení se uzavře nejméně nedávno použitá nečinná relace editoru. Normální relace prohlížeče se nepočítají. 0 nebo záporná hodnota znamená neomezený počet.
EditorSnapshotEveryOps50Při povolené perzistenci editoru (AddDoconutEditorPersistence) pořiďte 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 relace. 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 poskytovány JS/CSS/obrázky prohlížeče
    options.UnsafeMode      = false;          // udržujte zabezpečení relace zapnuté
    options.ShowDoconutInfo = false;
});

Další kroky

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