Instalacja

Dodaj Doconut do swojego projektu .NET 8

Podstawowa przeglądarka Doconut dla .NET 8 jest dostarczana jako pojedynczy pakiet NuGet, który integruje się z dowolną aplikacją ASP.NET Core. Opcjonalne wtyczki używają oddzielnych pakietów. Ta strona instaluje podstawowy pakiet i rejestruje middleware — minimalne wymagania przed pierwszym renderowaniem.

Wymagania

PlatformaObsługiwane
Windows x64 / x86Tak
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:8.0 image)Tak
Alpine and other musl-based distributionsNie
macOSNie

W systemie Linux zainstaluj bibliotekę konfiguracyjną czcionek przed otwarciem pierwszego dokumentu:

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

W systemach RHEL, Fedora i podobnych dystrybucjach pakiet jest fontconfig (dnf install -y fontconfig). To jedyny pakiet systemowy, którego potrzebuje Doconut: natywne biblioteki, z których korzysta, są dostarczane wewnątrz pakietu NuGet, a libgdiplus nie jest wymagany. Strony są renderowane przy użyciu czcionek zainstalowanych na serwerze, więc zobacz Rozwiązywanie problemów w celu uzyskania informacji o czcionkach i komunikatach o błędach w Linuksie.

Zainstaluj pakiet

bash
dotnet add package Doconut.NET8

Polecenie bez wersji instaluje najnowsze stabilne wydanie. Aby przypiąć wersję opisaną w tej dokumentacji, przekaż wersję jako oddzielną opcję:

bash
dotnet add package Doconut.NET8 --version 26.10.0

Doconut.NET8 jest identyfikatorem pakietu. Przyrostek wersji należy do pobranego pliku Doconut.NET8.<version>.nupkg i nie jest częścią identyfikatora.

Zarejestruj Doconut

AddDoconut() jest jedynym punktem wejścia rejestracji — istnieje pojedyncze przeciążenie, które podłącza usługę Viewer, usługę licencji oraz infrastrukturę renderowania do kontenera DI.

Dwa wywołania middleware kończą konfigurację i ich kolejność ma znaczenie: UseDoconutResources() musi być uruchomione przed UseDoconut(). UseDoconut() jest middleware terminalnym, więc wywołanie go jako pierwszego powoduje, że każde żądanie do zasobu /doconut-res nigdy nie dociera do obsługi zasobów i zwraca 404. UseDoconut() odpowiada na każde żądanie, które do niego dotrze, więc zamontuj go na własnej gałęzi przy użyciu app.Map. Połączenie sesji jest również wymagane — domyślne zabezpieczenie dokumentu Doconut weryfikuje każde żądanie strony względem stanu sesji ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // stan sesji wymaga pamięci podręcznej (MVC/Razor Pages już dodają jedną)
builder.Services.AddSession(); // Bezpieczeństwo dokumentów Doconut opiera się na stanie sesji ASP.NET

app.UseSession();          // wywołaj UseSession() przed UseDoconut()
app.UseDoconutResources(); // musi być zarejestrowane przed UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Wszystkie opcje

DoconutOptions akceptuje następujące konfigurowalne właściwości. Każda z nich jest opcjonalna — domyślne wartości poniżej mają zastosowanie, gdy właściwość nie zostanie ustawiona.

WłaściwośćDomyślnaOpis
ShowDoconutInfofalseGdy true, żądanie bez token zwraca baner wersji zamiast 404. Przydatne jako szybka kontrola; wyłącz w środowisku produkcyjnym.
UnsafeModefalseGdy true, pomija sprawdzanie zabezpieczeń sesji ASP.NET przy żądaniach stron. Wyłącz w środowisku produkcyjnym.
MiddlewarePath"/doconut"Wartość koordynacji dla punktu końcowego page-image. Jest walidowana, ale nie montuje gałęzi samodzielnie; utrzymuj ją zgodną z rzeczywistym mapowaniem UseDoconut() oraz klientem BasePath.
ResourcesPath"/doconut-res"Skąd serwowane są osadzone zasoby JS/CSS/obrazki.
LicensePath"" (empty string)Ścieżka do pliku licencji. Pusty ciąg oznacza przejście do kolejnego źródła, a następnie automatyczne wyszukiwanie.
LicenseContent"" (empty string)Surowa zawartość licencji — z zmiennej środowiskowej, menedżera tajemnic lub bazy danych.
LicenseStreamnullLicencja jako strumień, odczytywana raz przy uruchomieniu.
ResetLicensefalseZarezerwowany znacznik kompatybilności. Aktualne usługi .NET 8 odczytują licencję podczas AddDoconut(); po wymianie licencji zrestartuj aplikację.
MaxConcurrentEditorSessions200Maksymalna liczba aktywnych sesji edytora (dokumenty otwarte przy użyciu DocOptions.EditMode). Po przekroczeniu, najstarsza nieużywana sesja edytora jest zamykana. Normalne sesje przeglądarki nie są liczone. 0 lub wartość ujemna oznacza brak limitu.
EditorSnapshotEveryOps50Gdy włączona jest trwałość edytora (AddDoconutEditorPersistence), twórz migawki żywego dokumentu co N zarejestrowanych zmian. 0 lub wartość ujemna nigdy nie tworzy migawki w trakcie sesji. Brak efektu, gdy trwałość jest wyłączona.

Priorytet licencji, gdy ustawiono więcej niż jedno źródło: LicenseStream ma pierwszeństwo przed LicenseContent, przed LicensePath, przed automatycznym wyszukiwaniem — zobacz Konfiguracja licencji.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // skoordynuj z mapowaniem aplikacji i BasePath klienta
    options.ResourcesPath   = "/doconut-res"; // gdzie serwowane są pliki JS/CSS/images
    options.UnsafeMode      = false;          // zachowaj bezpieczeństwo sesji
    options.ShowDoconutInfo = false;
});

Kolejne kroki

Czy ta strona była pomocna?