Instalasi

Tambahkan Doconut ke proyek .NET 6 Anda

Penampil Doconut dasar untuk .NET 6 hadir sebagai satu paket NuGet yang dapat dipasang ke aplikasi ASP.NET Core apa pun. Plugin opsional menggunakan paket terpisah. Halaman ini menginstal paket dasar dan mendaftarkan middleware — minimum yang diperlukan sebelum render pertama Anda.

Persyaratan

Paket ini berjalan pada platform berikut:

PlatformDidukung
Windows x64 / x86Ya
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim image)Ya
Alpine and other musl-based distributionsTidak
macOSTidak

Di Linux, instal pustaka konfigurasi font sebelum dokumen pertama dibuka:

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

Pada distribusi RHEL, Fedora, dan serupa, paketnya adalah fontconfig (dnf install -y fontconfig). Itu satu-satunya paket sistem yang dibutuhkan Doconut: pustaka native yang digunakannya dikirim di dalam paket NuGet, dan libgdiplus tidak diperlukan. Di Docker, lebih pilih aspnet:6.0-bookworm-slim (Debian 12): tag aspnet:6.0 default adalah Debian 11, yang cermin paketnya dapat gagal menginstal libfontconfig1. Halaman digambar dengan font yang terpasang di server, jadi lihat Pemecahan Masalah untuk font dan pesan kesalahan Linux.

Instal paket

bash
dotnet add package Doconut.NET6

Perintah tanpa versi menginstal rilis stabil terbaru. Untuk mengunci rilis yang dijelaskan dalam dokumentasi ini, berikan versi sebagai opsi terpisah:

bash
dotnet add package Doconut.NET6 --version 26.10.0

Doconut.NET6 adalah ID paket. Akhiran versi termasuk dalam nama berkas Doconut.NET6.<version>.nupkg yang diunduh dan bukan bagian dari ID.

Identifikasi integrasi sebelum memperbarui

ID paket Doconut.NET6 telah digunakan oleh integrasi klasik dan .NET 6 saat ini. Jangan pilih dokumentasi hanya berdasarkan nama paket:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), synchronous OpenDocument(...), dan skrip penampil yang disalin secara manual mengidentifikasi integrasi klasik;
  • AddDoconut(), UseDoconutResources(), sebuah Viewer yang disuntikkan, dan OpenDocumentAsync(...) mengidentifikasi integrasi saat ini yang didokumentasikan di sini.

Manual penyiapan klasik yang diterjemahkan tetap tersedia. Gunakan panduan migrasi untuk mengubah generasi; pembaruan paket normal tidak mengonversi startup, masa pakai penampil, atau sumber daya peramban secara otomatis.

Daftarkan Doconut

AddDoconut() adalah satu-satunya titik masuk pendaftaran — ada satu overload, dan ia menghubungkan layanan Viewer, layanan lisensi, serta infrastruktur rendering ke dalam kontainer DI.

Dua pemanggilan middleware menyelesaikan penyiapan, dan urutannya penting: UseDoconutResources() harus dijalankan sebelum UseDoconut(). UseDoconut() adalah middleware terminal, sehingga memanggilnya terlebih dahulu berarti setiap permintaan ke aset /doconut-res tidak pernah mencapai penangan sumber daya dan menghasilkan 404. UseDoconut() menjawab setiap permintaan yang mencapainya, jadi pasang pada cabang terpisah dengan app.Map. Penyambungan sesi juga diperlukan — keamanan dokumen default Doconut memvalidasi setiap permintaan halaman terhadap status sesi ASP.NET.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // session state membutuhkan cache (MVC/Razor Pages sudah menambah satu)
builder.Services.AddSession(); // Keamanan dokumen Doconut berjalan di atas session state ASP.NET

app.UseSession();          // panggil UseSession() sebelum UseDoconut()
app.UseDoconutResources(); // harus didaftarkan sebelum UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Semua opsi

DoconutOptions menerima properti yang dapat diatur berikut ini. Semua bersifat opsional — nilai default di bawah berlaku ketika properti dibiarkan tidak diatur.

PropertiDefaultDeskripsi
ShowDoconutInfofalseKetika true, permintaan tanpa token mengembalikan banner versi alih-alih 404. Berguna sebagai pemeriksaan cepat; matikan dalam produksi.
UnsafeModefalseKetika true, melewati pemeriksaan keamanan sesi ASP.NET pada permintaan halaman. Matikan dalam produksi.
MiddlewarePath"/doconut"Nilai koordinasi untuk endpoint halaman-gambar. Nilai ini divalidasi, tetapi tidak membuat cabang sendiri; pertahankan selaras dengan pemetaan UseDoconut() yang sebenarnya dan BasePath klien.
ResourcesPath"/doconut-res"Dari mana sumber daya JS/CSS/gambar tersemat disajikan.
LicensePath"" (empty string)Jalur ke file lisensi. Kosong berarti melanjutkan ke sumber berikutnya, lalu pencarian otomatis.
LicenseContent"" (empty string)Konten lisensi mentah — dari variabel lingkungan, manajer rahasia, atau basis data.
LicenseStreamnullLisensi sebagai aliran, dibaca sekali saat startup.
ResetLicensefalseBendera kompatibilitas yang disiapkan. Layanan .NET 6 saat ini membaca lisensi selama AddDoconut(); restart aplikasi setelah mengganti lisensi.
MaxConcurrentEditorSessions200Jumlah maksimum sesi editor langsung (dokumen yang dibuka dengan DocOptions.EditMode). Di atasnya, sesi editor menganggur yang paling tidak baru digunakan akan ditutup. Sesi penampil normal tidak pernah dihitung. 0 atau nilai negatif berarti tidak ada batas.
EditorSnapshotEveryOps50Dengan persistensi editor diaktifkan (AddDoconutEditorPersistence), ambil snapshot dokumen langsung setiap N perubahan yang tercatat. 0 atau nilai negatif tidak pernah mengambil snapshot di tengah sesi. Tidak berpengaruh ketika persistensi dinonaktifkan.

Prioritas lisensi ketika lebih dari satu sumber diatur: LicenseStream mengalahkan LicenseContent mengalahkan LicensePath mengalahkan pencarian otomatis — lihat Penyiapan Lisensi.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // koordinasikan dengan pemetaan aplikasi dan BasePath klien
    options.ResourcesPath   = "/doconut-res"; // di mana JS/CSS/gambar viewer disajikan
    options.UnsafeMode      = false;          // jaga keamanan session tetap aktif
    options.ShowDoconutInfo = false;
});

Langkah selanjutnya

Apakah halaman ini membantu?