Instalasi
Tambahkan Doconut ke aplikasi web .NET Framework 4.7.2 Anda
Doconut.NETFramework menampung penampil Doconut dalam aplikasi ASP.NET klasik pada .NET Framework 4.7.2 — IIS atau IIS Express, MVC 5 atau Web Forms. Penyiapan memiliki tiga bagian: paket NuGet, dua pendaftaran di Web.config, dan satu pemanggilan di Global.asax. Halaman ini mencakup ketiganya; Panduan Cepat kemudian menempatkan dokumen pada halaman.
Persyaratan
- Proyek web menargetkan .NET Framework 4.7.2 atau lebih baru. Proyek 4.7 tidak dapat menggunakan paket ini; alihkan targetnya terlebih dahulu.
- Situs berjalan dalam integrated pipeline (default untuk pool aplikasi IIS dan IIS Express).
- Server menjalankan Windows. Paket ini hanya untuk Windows.
Halaman ini mencakup Doconut.NETFramework 26.9.0 dan yang lebih baru. Versi 26.8.0 dan sebelumnya menargetkan .NET Framework 4.7 dengan API yang berbeda; jalur itu dihentikan. Memperbarui aplikasi yang ada melintasi batas tersebut dibahas dalam Migrasi.
Instal paket
Dari Package Manager Console:
Install-Package Doconut.NETFrameworkAtau, dalam proyek bergaya SDK:
dotnet add package Doconut.NETFrameworkPerintah tanpa versi menginstal rilis stabil terbaru. Untuk mengunci rilis yang dijelaskan dalam dokumentasi ini, berikan versi:
Install-Package Doconut.NETFramework -Version 26.10.0dotnet add package Doconut.NETFramework --version 26.10.0Mesin rendering disematkan dalam paket: tidak ada assembly mesin terpisah untuk direferensikan, disalin, atau dideploy. Kapabilitas opsional dikirim sebagai paket masing-masing — misalnya Doconut.NETFramework.Converter dan Doconut.NETFramework.Dicom — dan masing-masing memerlukan lisensi yang memberikannya (lihat Sistem Plugin).
Konfigurasi Web.config
Doconut melayani dua jenis permintaan, dan IIS mengarahkan keduanya melalui Web.config:
DocImage.axd— halaman penampil, thumbnail, pencarian, dan titik akhir anotasi, dilayani olehDoconut.DocImageHandler./doconut-res/*— skrip, stylesheet, dan ikon milik penampil, disematkan dalam assembly dan dilayani olehDoconut.DoconutResourceModule.
Tambahkan keduanya, plus pengaturan yang mereka bergantung pada:
<configuration>
<system.web>
<!-- Hanya MVC 5: Razor mengompilasi tampilan pada waktu berjalan dan membutuhkan netstandard facade. -->
<compilation targetFramework="4.7.2">
<assemblies>
<add assembly="netstandard, Version=2.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51" />
</assemblies>
</compilation>
<!-- maxRequestLength dalam KILOBYTES: 200 MB. -->
<httpRuntime targetFramework="4.7.2" maxRequestLength="204800" />
<!-- Baca file .cshtml dan .aspx sebagai UTF-8, bukan sebagai halaman kode ANSI server's. -->
<globalization fileEncoding="utf-8" requestEncoding="utf-8" responseEncoding="utf-8" />
</system.web>
<system.webServer>
<security>
<requestFiltering>
<!-- maxAllowedContentLength dalam BYTES: 200 MB yang sama. -->
<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>Setiap baris mencegah kegagalan yang tidak menghasilkan pengecualian:
verb="GET,HEAD,POST"— pertahankanHEAD. Penampil mengirim permintaanHEADuntuk halaman 1 guna mendeteksi gambar animasi. Tanpa kata kerja tersebut, IIS menjawab404sebelum penangkap berjalan: dokumen tetap ditampilkan, tetapi deteksi animasi tidak pernah berfungsi dan konsol browser dipenuhi 404.runAllManagedModulesForAllRequests="true"—/doconut-res/*.js,.css, dan.pngtampak seperti file statis, dan IIS akan menyerahkannya ke penangkap file statis sebelum modul sumber daya melihatnya. Hasilnya adalah penampil tanpa skrip atau ikon.<globalization fileEncoding="utf-8">— file halaman yang disimpan sebagai UTF-8 tanpa byte-order mark akan dibaca dengan halaman kode ANSI server, sehingga setiap karakter non-ASCII sampai ke browser terkode ganda (em dash muncul sebagai—). File tersebut benar di disk, dan halaman masih menyatakan<meta charset="utf-8">.- Assembly
netstandard(MVC 5) — Razor mengompilasi tampilan saat pertama diminta, dengan daftar referensi sendiri yang tidak mencakup fasad ini. Tampilan yang melakukan apa pun secara dinamis selain akses anggota sederhana kemudian gagal denganCS0012dan memberikan500kosong, dan hanya halaman yang memicu kegagalan yang terpengaruh. Kesalahan kompilator muncul hanya di log peristiwa Windows (sumber ASP.NET). Aplikasi Web Forms tidak memerlukan baris ini. - Batas unggahan — ASP.NET membaca seluruh isi permintaan sebelum penangkap apa pun berjalan, sehingga unggahan di atas batas ini ditolak oleh IIS dengan halaman kesalahan miliknya. Pertahankan
maxRequestLength(kilobyte) danmaxAllowedContentLength(byte) secara selaras, dan di atas file terbesar yang dibuka atau diunggah pengguna Anda.
Dua pengaturan lagi penting, dan keduanya biasanya sudah benar:
- Status sesi tetap aktif. Secara default halaman hanya dilayani ke sesi ASP.NET yang membuka dokumen, jadi situs tidak boleh mengatur
<sessionState mode="Off" />. Lihat Sesi & Keamanan. - Pengalihan binding. Pertahankan pengalihan binding
<runtime>yang ditulis NuGet ke dalamWeb.config. Dalam proyek bergaya SDK, salin mereka daribin\<YourApp>.dll.configyang dihasilkan, karena ASP.NET klasik hanya membaca pengalihan dariWeb.config. Pengalihan yang menyebutkan versi yang tidak ada dibin\menghentikan seluruh aplikasi dengan500kosong saat startup.
Daftarkan Doconut di Global.asax
Tidak ada builder dan tidak ada pipeline middleware di System.Web. Doconut disusun sekali per proses pekerja oleh DoconutHost.Initialize di Application_Start, dan dilepaskan oleh DoconutHost.Shutdown di Application_End:
// 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 membangun layanan handler, modul sumber daya, dan penggunaan kode Anda sendiri. Kode Anda mengaksesnya melalui DoconutHost.Services (lihat DoconutHost). Hanya panggilan pertama yang mengonfigurasi apa pun; panggilan kedua diabaikan. Dalam aplikasi MVC, juga pastikan dua jalur Doconut tidak masuk ke routing — Quick Start menunjukkan Application_Start lengkap.
Semua opsi
DoconutOptions menerima properti yang dapat diatur berikut ini. Semua bersifat opsional.
| Properti | Bawaan | Deskripsi |
|---|---|---|
UnsafeMode | false | Ketika false, DocImage.axd menyajikan halaman hanya untuk sesi ASP.NET yang membuka dokumen. Ketika true, setiap permintaan yang membawa token akan dilayani. Biarkan false. |
ShowDoconutInfo | false | Ketika true, permintaan DocImage.axd tanpa token menjawab banner versi alih-alih 404. Berguna sebagai pemeriksaan cepat; biarkan dimatikan di produksi. |
ResourcesPath | "/doconut-res" | Di mana modul sumber daya menyajikan skrip, gaya, dan ikon yang tersemat. Ubah hanya bersamaan dengan ResPath penampil dan setiap MVC IgnoreRoute. |
LicensePath | "" | Jalur lengkap ke file lisensi. Kosong berarti melanjutkan ke sumber berikutnya, lalu ke penemuan otomatis. |
LicenseContent | "" | Konten lisensi mentah — dari variabel lingkungan, penyimpanan rahasia, atau basis data. |
LicenseStream | null | Lisensi sebagai aliran, dibaca sekali saat startup. |
MiddlewarePath | "/doconut" | Tidak digunakan pada paket ini. Titik akhir halaman adalah handler DocImage.axd yang dideklarasikan di Web.config, apa pun nilai yang diatur. Masih divalidasi: harus dimulai dengan / dan berbeda dari ResourcesPath. |
ResetLicense | false | Tidak digunakan pada paket ini. Lisensi dibaca sekali, di DoconutHost.Initialize; daur ulang pool aplikasi setelah mengganti file lisensi. |
MaxConcurrentEditorSessions | 200 | Jumlah maksimum sesi editor aktif (dokumen dibuka dengan DocOptions.EditMode). Melebihi itu, sesi editor menganggur yang paling tidak baru digunakan akan ditutup. Sesi penampil normal tidak pernah dihitung. 0 atau nilai negatif berarti tidak ada batas. |
EditorSnapshotEveryOps | 50 | Dengan persistensi editor diaktifkan (AddDoconutEditorPersistence), ambil snapshot dokumen aktif setiap N perubahan yang tercatat. 0 atau nilai negatif tidak pernah mengambil snapshot di tengah sesi. Tidak berpengaruh ketika persistensi dinonaktifkan. |
Ketika lebih dari satu sumber lisensi diatur, LicenseStream mengalahkan LicenseContent, yang mengalahkan LicensePath, yang mengalahkan penemuan otomatis — lihat License Setup.
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.ResourcesPath = "/doconut-res"; // di mana JS/CSS/gambar viewer disajikan
options.UnsafeMode = false; // pertahankan keamanan sesi
options.ShowDoconutInfo = false;
});
// Endpoint halaman bukan pilihan di sini: itu adalah handler DocImage.axd yang dideklarasikan di Web.config.Langkah selanjutnya
- Quick Start — buka sebuah dokumen dan render di peramban, dalam MVC 5 atau Web Forms.
- License Setup — tempat Doconut mencari file lisensi Anda.
Apakah halaman ini membantu?