Instalasi

Tambahkan Doconut ke proyek .NET 8 Anda

Penampil dasar Doconut untuk .NET 8 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 — hal minimum yang diperlukan sebelum render pertama Anda.

Instal paket

bash
dotnet add package Doconut.NET8

Perintah tanpa versi menginstal rilis stabil terbaru. Untuk mereproduksi rilis 26.7.0 secara tepat, berikan versi sebagai opsi terpisah:

bash
dotnet add package Doconut.NET8 --version 26.7.0

Doconut.NET8 adalah ID paket. Akhiran .26.7.0 milik nama file Doconut.NET8.26.7.0.nupkg yang diunduh dan bukan bagian dari ID.

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. Penyambungan sesi juga diperlukan — keamanan dokumen Doconut secara default memvalidasi setiap permintaan halaman terhadap status sesi ASP.NET.

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();

Semua opsi

DoconutOptions menerima properti‑properti yang dapat diatur berikut. Semua bersifat opsional — nilai bawaan di bawah berlaku ketika sebuah properti tidak diatur.

PropertiBawaanDeskripsi
ShowDoconutInfofalseKetika true, permintaan tanpa token mengembalikan spanduk versi alih-alih 404. Berguna sebagai pemeriksaan cepat; matikan di produksi.
UnsafeModefalseKetika true, melewati pemeriksaan keamanan sesi ASP.NET pada permintaan halaman. Matikan di produksi.
MiddlewarePath"/doconut"Nilai koordinasi untuk endpoint gambar‑halaman. Nilai ini divalidasi, tetapi tidak secara otomatis memasang cabang; pertahankan konsistensi dengan pemetaan UseDoconut() aktual dan BasePath klien.
ResourcesPath"/doconut-res"Lokasi dimana sumber daya JS/CSS/gambar yang disematkan disajikan.
LicensePath"" (string kosong)Jalur ke berkas lisensi. Kosong berarti melanjutkan ke sumber berikutnya, lalu pencarian otomatis.
LicenseContent"" (string kosong)Konten lisensi mentah — dari variabel lingkungan, manajer rahasia, atau basis data.
LicenseStreamnullLisensi sebagai aliran, dibaca sekali saat start-up.
ResetLicensefalseBendera kompatibilitas yang disiapkan. Layanan .NET 8 saat ini membaca lisensi selama AddDoconut(); restart aplikasi setelah mengganti lisensi.

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

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;
});

Langkah selanjutnya

Apakah halaman ini membantu?