Instalace

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

Základní prohlížeč Doconut pro .NET 6 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.

Instalace balíčku

bash
dotnet add package Doconut.NET6

Příkaz bez verze nainstaluje nejnovější stabilní verzi. Pro přesné reprodukování aktuální verze 26.7.0 zadejte verzi jako samostatnou volbu:

bash
dotnet add package Doconut.NET6 --version 26.7.0

Doconut.NET6 je ID balíčku. Přípona .26.7.0 patří ke staženému souboru Doconut.NET6.26.7.0.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 na základě 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 stále k dispozici. Použijte průvodce migrací k přechodu mezi generacemi; běžná aktualizace balíčku automaticky nepřevádí spouštění, ž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 pokud je voláno jako první, každá žádost o prostředek /doconut-res nikdy nedosáhne obsluhy zdrojů a vrátí 404. Propojení sezení je také vyžadováno — výchozí zabezpečení dokumentů Doconut ověřuje každou žádost o stránku vůči stavu ASP.NET session.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // stav session potřebuje cache (MVC/Razor Pages již přidávají jeden)
builder.Services.AddSession(); // zabezpečení dokumentů Doconut funguje na ASP.NET session state

app.UseSession();          // zavolejte UseSession() před UseDoconut()
app.UseDoconutResources(); // musí být zaregistrováno před UseDoconut()
app.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ž je true, požadavek bez token vrátí banner s verzí místo 404. Užitečné jako rychlá kontrola; v produkci vypněte.
UnsafeModefalseKdyž je 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 stránky-obrázku. 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 spuštění.
ResetLicensefalseRezervovaný příznak kompatibility. Současné služby .NET 6 čtou licenci během AddDoconut(); po výměně licence restartujte aplikaci.

Priorita licencí, když je nastaveno více zdrojů: LicenseStream má přednost před LicenseContent, který má přednost před LicensePath, který má přednost 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 klientským BasePath
    options.ResourcesPath   = "/doconut-res"; // odkud jsou poskytovány JS/CSS/obrázky prohlížeče
    options.UnsafeMode      = false;          // udržujte zabezpečení session aktivní
    options.ShowDoconutInfo = false;
});

Další kroky

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