Kurulum

Doconut'u .NET 8 projenize ekleyin

Temel Doconut görüntüleyicisi .NET 8 için, herhangi bir ASP.NET Core uygulamasına takılan tek bir NuGet paketi olarak gelir. İsteğe bağlı eklentiler ayrı paketler kullanır. Bu sayfa temel paketi kurar ve ara katmanı (middleware) kaydeder — ilk render'ınızdan önce gereken minimum.

Gereksinimler

Paket şu platformlarda çalışır:

PlatformDestekleniyor
Windows x64 / x86Evet
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:8.0 image)Evet
Alpine and other musl-based distributionsHayır
macOSHayır

Linux'ta, ilk belge açılmadan önce font yapılandırma kütüphanesini kurun:

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

RHEL, Fedora ve benzeri dağıtımlarda paket fontconfig (dnf install -y fontconfig) şeklindedir. Bu, Doconut'un ihtiyaç duyduğu tek sistem paketidir: kullandığı yerel kütüphaneler NuGet paketinin içinde gelir ve libgdiplus gerekli değildir. Sayfalar sunucuda yüklü fontlarla çizilir, bu yüzden fontlar ve Linux hata mesajları için Sorun Giderme bölümüne bakın.

Paketi Kurun

bash
dotnet add package Doconut.NET8

Sürüm belirtilmemiş komut en son kararlı sürümü kurar. Bu belgede açıklanan sürümü sabitlemek için, sürümü ayrı bir seçenek olarak geçirin:

bash
dotnet add package Doconut.NET8 --version 26.10.0

Doconut.NET8 paket kimliğidir. Sürüm soneki, indirilen Doconut.NET8.<version>.nupkg dosya adının bir parçasıdır ve kimliğin bir bölümü değildir.

Doconut'u Kaydedin

AddDoconut() tek kayıt giriş noktasıdır — tek bir aşırı yükleme vardır ve Viewer hizmetini, lisans hizmetini ve render altyapısını DI konteynerine bağlar.

Kurulumu tamamlamak için iki ara katman çağrısı gerekir ve sıraları önemlidir: UseDoconutResources(), UseDoconut()'dan önce çalışmalıdır. UseDoconut() uç bir ara katmandır, bu yüzden onu önce çağırmak, bir /doconut-res varlığına yapılan her isteğin kaynak işleyicisine ulaşamamasına ve 404 hatası almasına neden olur. UseDoconut() ona ulaşan her isteğe yanıt verir, bu yüzden kendi dalında app.Map ile monte edin. Oturum bağlaması da gereklidir — Doconut'un varsayılan belge güvenliği, her sayfa isteğini ASP.NET oturum durumuna karşı doğrular.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // oturum durumu bir önbelleğe ihtiyaç duyar (MVC/Razor Pages zaten bir tane ekler)
builder.Services.AddSession(); // Doconut belge güvenliği ASP.NET oturum durumuna dayanır

app.UseSession();          // UseSession()'ı UseDoconut()'dan önce çağırın
app.UseDoconutResources(); // UseDoconut()'dan önce kaydedilmelidir
app.Map("/doconut", branch => branch.UseDoconut());

Tüm seçenekler

DoconutOptions aşağıdaki ayarlanabilir özellikleri kabul eder. Her biri isteğe bağlıdır — bir özellik ayarlanmamışsa aşağıdaki varsayılanlar uygulanır.

ÖzellikVarsayılanAçıklama
ShowDoconutInfofalsetrue olduğunda, token içermeyen bir istek 404 yerine bir sürüm banner'ı döndürür. Duman kontrolü olarak faydalıdır; üretimde kapatın.
UnsafeModefalsetrue olduğunda, sayfa isteklerinde ASP.NET-oturum güvenlik kontrolünü atlar. Üretimde kapatın.
MiddlewarePath"/doconut"Sayfa-görsel uç noktası için koordinasyon değeri. Doğrulanır, ancak tek başına bir dal oluşturmaz; gerçek UseDoconut() eşlemesi ve istemci BasePath ile uyumlu tutun.
ResourcesPath"/doconut-res"Gömülü JS/CSS/görsel kaynaklarının nereden sunulduğu.
LicensePath"" (empty string)Lisans dosyasının yolu. Boş ise bir sonraki kaynağa geçilir, ardından otomatik arama yapılır.
LicenseContent"" (empty string)Ham lisans içeriği — bir ortam değişkeni, gizli yönetici veya veritabanından.
LicenseStreamnullLisans bir akış olarak, başlangıçta bir kez okunur.
ResetLicensefalseAyrılmış uyumluluk bayrağı. Mevcut .NET 8 hizmetleri lisansı AddDoconut() sırasında okur; bir lisans değiştirildikten sonra uygulamayı yeniden başlatın.
MaxConcurrentEditorSessions200Canlı editör oturumlarının (DocOptions.EditMode ile açılan belgeler) maksimum sayısı. Bu sayının üzerine çıkıldığında, en az kullanılan boşta kalan editör oturumu kapatılır. Normal görüntüleyici oturumları hiç sayılmaz. 0 veya negatif bir değer sınırlama olmadığını gösterir.
EditorSnapshotEveryOps50Editör kalıcılığı etkinleştirildiğinde (AddDoconutEditorPersistence), canlı belge her N kaydedilen değişiklikte bir anlık görüntü alınır. 0 veya negatif bir değer oturum ortasında anlık görüntü almaz. Kalıcılık devre dışı bırakıldığında etkisi yoktur.

Birden fazla kaynak ayarlandığında lisans önceliği: LicenseStream, LicenseContent, LicensePath ve otomatik arama sırasıyla önceliklidir — Lisans Kurulumu bölümüne bakın.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // app haritalaması ve istemci BasePath'iyle koordine edin
    options.ResourcesPath   = "/doconut-res"; // görüntüleyicinin JS/CSS/görsellerinin hizmet verildiği yer
    options.UnsafeMode      = false;          // oturum güvenliğini açık tut
    options.ShowDoconutInfo = false;
});

Sonraki adımlar

Bu sayfa yardımcı oldu mu?