Kurulum

Doconut'ı .NET 6 projenize ekleyin

.NET 6 için temel Doconut görüntüleyicisi, herhangi bir ASP.NET Core uygulamasına bağlanan tek bir NuGet paketi olarak sunulur. İ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 şey.

Paketi kurun

bash
dotnet add package Doconut.NET6

Versiyonsuz komut, en son kararlı sürümü kurar. Mevcut 26.7.0 sürümünü tam olarak yeniden üretmek için, sürümü ayrı bir seçenek olarak geçirin:

bash
dotnet add package Doconut.NET6 --version 26.7.0

Doconut.NET6 paket kimliğidir. .26.7.0 eki, indirilen Doconut.NET6.26.7.0.nupkg dosya adının bir parçasıdır ve kimliğin bir parçası değildir.

Yükseltmeden önce entegrasyonu tanımlayın

Doconut.NET6 paket kimliği, hem klasik hem de mevcut .NET 6 entegrasyonları tarafından kullanılmıştır. Belgeleri yalnızca paket adından seçmeyin:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), senkron OpenDocument(...) ve manuel olarak kopyalanmış görüntüleyici betikleri klasik entegrasyon tanımlar;
  • AddDoconut(), UseDoconutResources(), enjekte edilmiş bir Viewer ve OpenDocumentAsync(...) mevcut entegrasyonu tanımlar; burada belgelenmiştir.

Çevrilmiş klasik kurulum kılavuzu hâlâ mevcuttur. Nesilleri değiştirmek için göç rehberi kullanın; normal bir paket güncellemesi başlangıç, görüntüleyici ömrü veya tarayıcı kaynaklarını otomatik olarak dönüştürmez.

Doconut'ı kaydedin

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

Kurulumu tamamlamak için iki middleware çağrısı vardır ve sıraları önemlidir: UseDoconutResources() UseDoconut()'dan önce çalışmalıdır. UseDoconut() uç bir middleware olduğundan, onu önce çağırmak, /doconut-res varlığına yapılan her isteğin kaynak işleyicisine ulaşamamasına ve 404 hatası almasına neden olur. Oturum bağlaması da gereklidir — Doconut'ın 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.AddSession(); // Doconut document security rides on ASP.NET session state

app.UseSession();          // call UseSession() before UseDoconut()
app.UseDoconutResources(); // must be registered before UseDoconut()
app.UseDoconut();

Tüm seçenekler

DoconutOptions aşağıdaki ayarlanabilir özellikleri kabul eder. Hepsi 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. Bir ön kontrol olarak faydalıdır; üretimde kapalı tutun.
UnsafeModefalsetrue olduğunda, sayfa isteklerinde ASP.NET-oturum güvenlik kontrolünü atlar. Üretimde kapalı tutun.
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 sunulduğu yer.
LicensePath"" (empty string)Lisans dosyasının yolu. Boş olması, bir sonraki kaynağa geçileceği ve ardından otomatik arama yapılacağı anlamına gelir.
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 6 servisleri lisansı AddDoconut() sırasında okur; bir lisans değiştirildikten sonra uygulamayı yeniden başlatın.

Birden fazla kaynak ayarlandığında lisans önceliği: LicenseStream, LicenseContent'i, LicensePath'i ve otomatik aramayı geçer — bkz. Lisans Kurulumu.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // coordinate with app mapping and client BasePath
    options.ResourcesPath   = "/doconut-res"; // where the viewer's JS/CSS/images are served from
    options.UnsafeMode      = false;          // keep session security on
    options.ShowDoconutInfo = false;
});

Sonraki adımlar

Bu sayfa yardımcı oldu mu?