Kurulum

Doconut'u .NET Framework 4.7.2 web uygulamanıza ekleyin

Doconut.NETFramework, .NET Framework 4.7.2 üzerinde klasik bir ASP.NET uygulamasında Doconut görüntüleyicisini barındırır — IIS veya IIS Express, MVC 5 veya Web Forms. Kurulum üç bölümden oluşur: NuGet paketi, Web.config içinde iki kayıt ve Global.asax içinde bir çağrı. Bu sayfa üçünü de kapsar; Quick Start ardından bir belgeyi bir sayfaya koyar.

Gereksinimler

  • Web projesi .NET Framework 4.7.2 veya daha yenisini hedeflemelidir. 4.7 projesi bu paketi tüketemez; önce hedefi değiştirin.
  • Site, entegre pipeline içinde çalışır (IIS ve IIS Express uygulama havuzları için varsayılan).
  • Sunucu Windows üzerinde çalışır. Paket yalnızca Windows içindir.

Bu sayfa Doconut.NETFramework 26.9.0 ve üzeri sürümlerini kapsar. 26.8.0 ve öncesi sürümler .NET Framework 4.7'yi farklı bir API ile hedeflemişti; bu hat artık kullanılmamaktadır. Mevcut bir uygulamayı bu sınırın ötesine güncellemek Migration içinde ele alınmıştır.

Paketi Kur

Package Manager Console'dan:

powershell
Install-Package Doconut.NETFramework

Veya, SDK tarzı bir projede:

bash
dotnet add package Doconut.NETFramework

Sürüm belirtilmemiş komutlar en son kararlı sürümü kurar. Bu belgede açıklanan sürümü sabitlemek için, sürümü belirtin:

powershell
Install-Package Doconut.NETFramework -Version 26.10.0
bash
dotnet add package Doconut.NETFramework --version 26.10.0

Render motoru paket içinde gömülüdür: referans gösterecek, kopyalayacak veya dağıtacak ayrı bir motor derlemesi yoktur. İsteğe bağlı özellikler kendi paketleri olarak gelir — örneğin Doconut.NETFramework.Converter ve Doconut.NETFramework.Dicom — ve her biri ona izin veren bir lisans gerektirir (bkz. Plugin System).

Web.config'i Yapılandır

Doconut iki tür isteği hizmet eder ve IIS her ikisini de Web.config üzerinden yönlendirir:

  • DocImage.axd — görüntüleyicinin sayfası, küçük resim, arama ve açıklama uç noktası, Doconut.DocImageHandler tarafından sunulur.
  • /doconut-res/* — görüntüleyicinin kendi betikleri, stil sayfaları ve simgeleri, derlemede gömülüdür ve Doconut.DoconutResourceModule tarafından sunulur.

Her ikisini ve onlara bağımlı ayarları ekleyin:

xml
<configuration>
  <system.web>
    <!-- MVC 5 yalnızca: Razor, görünümleri çalışma zamanında derler ve netstandard ara yüzüne ihtiyaç duyar. -->
    <compilation targetFramework="4.7.2">
      <assemblies>
        <add assembly="netstandard, Version=2.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51" />
      </assemblies>
    </compilation>
    <!-- maxRequestLength KILOBYTES içinde: 200 MB. -->
    <httpRuntime targetFramework="4.7.2" maxRequestLength="204800" />
    <!-- .cshtml ve .aspx dosyalarını UTF-8 olarak okuyun, sunucunun ANSI kod sayfası olarak değil. -->
    <globalization fileEncoding="utf-8" requestEncoding="utf-8" responseEncoding="utf-8" />
  </system.web>
  <system.webServer>
    <security>
      <requestFiltering>
        <!-- maxAllowedContentLength BYTES içinde: aynı 200 MB. -->
        <requestLimits maxAllowedContentLength="209715200" />
      </requestFiltering>
    </security>
    <modules runAllManagedModulesForAllRequests="true">
      <add name="DoconutResourceModule" type="Doconut.DoconutResourceModule, Doconut" />
    </modules>
    <handlers>
      <add name="DocImage" verb="GET,HEAD,POST" path="DocImage.axd"
           type="Doconut.DocImageHandler, Doconut" />
    </handlers>
  </system.webServer>
</configuration>

Her satır, istisna oluşturmayan bir hatayı önler:

  • verb="GET,HEAD,POST" — HEAD tutun. Görüntüleyici, hareketli görüntüleri algılamak için sayfa 1'e bir HEAD isteği gönderir. Fiil olmadan, IIS işleyici çalışmadan önce 404 yanıtını verir: belgeler hâlâ gösterilir, ancak animasyon algılaması hiç çalışmaz ve tarayıcı konsolu 404 hatalarıyla dolar.
  • runAllManagedModulesForAllRequests="true" — /doconut-res/*.js, .css ve .png statik dosyalar gibi görünür ve IIS, kaynak modülü görmeden önce bunları statik dosya işleyicisine verir. Sonuç, betik veya simge içermeyen bir görüntüleyicidir.
  • <globalization fileEncoding="utf-8"> — sayfa dosyaları bayt sırası işareti olmadan UTF-8 olarak kaydedildiğinde, sunucunun ANSI kod sayfası ile okunur, bu yüzden her ASCII olmayan karakter tarayıcıya çift kodlanmış olarak ulaşır (bir uzun tire — olarak gösterilir). Dosya diskte doğrudur ve sayfa hâlâ <meta charset="utf-8"> bildirir.
  • The netstandard assembly (MVC 5) — Razor, görünümleri ilk istendiğinde derler ve bu katman bu arayüzü içermeyen kendi referans listesini kullanır. Düz bir üye erişiminin ötesinde dinamik bir şey yapan bir görünüm, CS0012 hatası verir ve boş bir 500 yanıtı döndürür; sadece bu hatayı tetikleyen sayfalar başarısız olur. Derleyici hatası yalnızca Windows olay günlüğünde (kaynak ASP.NET) görünür. Web Forms uygulamaları bu satıra ihtiyaç duymaz.
  • Yükleme limitleri — ASP.NET, herhangi bir işleyici çalışmadan önce tüm istek gövdesini okur, bu yüzden bu limitlerin üzerindeki bir yükleme IIS tarafından kendi hata sayfasıyla reddedilir. maxRequestLength (kilobayt) ve maxAllowedContentLength (bayt) değerlerini uyumlu tutun ve kullanıcılarınızın açtığı ya da yüklediği en büyük dosyanın üzerindeki değerleri aşmayın.

İki ek ayar daha önemlidir ve ikisi de genellikle zaten doğrudur:

  • Oturum durumu açık kalır. Varsayılan olarak bir sayfa yalnızca belgeyi açan ASP.NET oturumuna hizmet eder, bu yüzden site <sessionState mode="Off" /> ayarlamamalıdır. Bkz. Sessions & Security.
  • Bağlama yönlendirmeleri. NuGet'in Web.config içine yazdığı <runtime> bağlama yönlendirmelerini tutun. SDK tarzı bir projede, oluşturulan bin\<YourApp>.dll.config'den kopyalayın, çünkü klasik ASP.NET yönlendirmeleri yalnızca Web.config'den okur. bin\ içinde eksik bir sürümü adlandıran bir yönlendirme, başlangıçta boş bir 500 ile tüm uygulamayı durdurur.

Global.asax'ta Doconut'ı Kaydet

System.Web içinde bir oluşturucu ve ara katman (middleware) boru hattı yoktur. Doconut, DoconutHost.Initialize tarafından Application_Start içinde bir kez işçi süreci başına oluşturulur ve DoconutHost.Shutdown tarafından Application_End içinde serbest bırakılır:

csharp
// Global.asax.cs
protected void Application_Start()
{
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    });
}

protected void Application_End()
{
    Doconut.DoconutHost.Shutdown();
}

DoconutHost.Initialize hizmetleri, işleyiciyi, kaynak modülünü ve kendi kodunuzun kullanımını oluşturur. Kodunuz onlara DoconutHost.Services aracılığıyla ulaşır (DoconutHost bakınız). Yalnızca ilk çağrı her şeyi yapılandırır; ikinci çağrı yok sayılır. Bir MVC uygulamasında, iki Doconut yolunu yönlendirmeden dışarıda tutun — Quick Start tam Application_Start gösterir.

Tüm seçenekler

DoconutOptions aşağıdaki ayarlanabilir özellikleri kabul eder. Her biri isteğe bağlıdır.

ÖzellikVarsayılanAçıklama
UnsafeModefalsefalse olduğunda, DocImage.axd yalnızca belgeyi açan ASP.NET oturumuna bir sayfa sunar. true olduğunda, tokeni taşıyan herhangi bir istek sunulur. false bırakın.
ShowDoconutInfofalsetrue olduğunda, token içermeyen bir DocImage.axd isteği 404 yerine bir sürüm bannerı yanıtlar. Duman kontrolü olarak faydalıdır; üretimde kapalı bırakın.
ResourcesPath"/doconut-res"Kaynak modülünün gömülü betikleri, stilleri ve simgeleri nerede sunduğu. Bunu yalnızca görüntüleyicinin ResPath ve herhangi bir MVC IgnoreRoute ile birlikte değiştirin.
LicensePath""Lisans dosyasının tam yolu. Boş bırakılırsa bir sonraki kaynağa, ardından otomatik keşfe geçilir.
LicenseContent""Ham lisans içeriği — bir ortam değişkeni, gizli bir depolama veya bir veritabanından.
LicenseStreamnullLisans bir akış olarak, başlangıçta bir kez okunur.
MiddlewarePath"/doconut"Bu paket içinde kullanılmaz. Sayfa uç noktası, Web.config içinde bildirilen DocImage.axd işleyicisidir, neye ayarlanırsa ayarlansın. Yine de doğrulanır: / ile başlamalı ve ResourcesPath'den farklı olmalıdır.
ResetLicensefalseBu paket içinde kullanılmaz. Lisans bir kez, DoconutHost.Initialize içinde okunur; bir lisans dosyası değiştirildikten sonra uygulama havuzunu yeniden başlatın.
MaxConcurrentEditorSessions200Canlı düzenleyici oturumlarının (DocOptions.EditMode ile açılan belgeler) maksimum sayısı. Bu sayı aşıldığında, en az kullanılan boşta kalan düzenleyici oturumu kapatılır. Normal görüntüleyici oturumları asla sayılmaz. 0 veya negatif bir değer sınırlama olmadığı anlamına gelir.
EditorSnapshotEveryOps50Düzenleyici kalıcılığı (AddDoconutEditorPersistence) etkinleştirildiğinde, canlı belgeyi her N kaydedilen değişiklikte bir anlık görüntü al. 0 veya negatif bir değer oturum ortasında asla anlık görüntü almaz. Kalıcılık devre dışı bırakıldığında etkisi yoktur.

Birden fazla lisans kaynağı ayarlandığında, LicenseStream, LicenseContent ve LicensePath sırasıyla otomatik keşfi geçersiz kılar — bakınız Lisans Kurulumu.

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath     = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    options.ResourcesPath   = "/doconut-res"; // görüntüleyicinin JS/CSS/images nereden sunulduğu
    options.UnsafeMode      = false;          // oturum güvenliğini açık tut
    options.ShowDoconutInfo = false;
});
// Sayfa uç noktası burada bir seçenek değil: Web.config içinde bildirilen DocImage.axd işleyicisidir.

Sonraki adımlar

  • Hızlı Başlangıç — bir belge açın ve tarayıcıda, MVC 5 veya Web Forms içinde render edin.
  • Lisans Kurulumu — Doconut'un lisans dosyanızı nerede aradığını gösterir.

Bu sayfa yardımcı oldu mu?