การติดตั้ง

เพิ่ม Doconut ไปยังโครงการ .NET 8 ของคุณ

Viewer พื้นฐานของ Doconut สำหรับ .NET 8 มาพร้อมกับแพ็กเกจ NuGet เพียงหนึ่งชุดที่สามารถเชื่อมต่อกับแอปพลิเคชัน ASP.NET Core ใดก็ได้ ปลั๊กอินเสริมใช้แพ็กเกจแยกต่างหาก หน้าดังนี้ทำการติดตั้งแพ็กเกจพื้นฐานและลงทะเบียน middleware — ขั้นตอนขั้นต่ำที่จำเป็นก่อนการแสดงผลครั้งแรกของคุณ.

ติดตั้งแพ็กเกจ

bash
dotnet add package Doconut.NET8

คำสั่งที่ไม่มีระบุเวอร์ชันจะติดตั้งรุ่นเสถียรล่าสุด เพื่อทำให้ได้รุ่น 26.7.0 ปัจจุบันอย่างแม่นยำ ให้ระบุเวอร์ชันเป็นตัวเลือกแยก:

bash
dotnet add package Doconut.NET8 --version 26.7.0

Doconut.NET8 คือ ID ของแพ็กเกจ ส่วนต่อท้าย .26.7.0 เป็นของชื่อไฟล์ Doconut.NET8.26.7.0.nupkg ที่ดาวน์โหลดมาและไม่ได้เป็นส่วนของ ID.

ลงทะเบียน Doconut

AddDoconut() เป็นจุดเข้าถึงการลงทะเบียนเดียว — มี overload เพียงหนึ่งเดียวและมันเชื่อมต่อบริการ Viewer บริการใบอนุญาต และโครงสร้างพื้นฐานการเรนเดอร์เข้าไปใน DI container.

การเรียก middleware สองครั้งทำให้การตั้งค่าเสร็จสมบูรณ์และลำดับการเรียกมีความสำคัญ: UseDoconutResources() ต้องทำงานก่อน UseDoconut() UseDoconut() เป็น middleware สุดท้าย ดังนั้นการเรียกมันก่อนหมายความว่าทุกคำขอไปยังทรัพยากร /doconut-res จะไม่ถึงตัวจัดการทรัพยากรและจะได้ 404 การเชื่อมต่อ session ก็จำเป็นเช่นกัน — ระบบความปลอดภัยเอกสารเริ่มต้นของ Doconut จะตรวจสอบทุกคำขอหน้าเทียบกับสถานะ session ของ 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();

ตัวเลือกทั้งหมด

DoconutOptions รองรับคุณสมบัติต่อไปนี้ที่สามารถตั้งค่าได้ ทุกคุณสมบัติเป็นทางเลือก — ค่าตั้งต้นด้านล่างจะใช้เมื่อคุณสมบัตินั้นไม่ได้กำหนดค่า.

คุณสมบัติค่าเริ่มต้นคำอธิบาย
ShowDoconutInfofalseเมื่อเป็น true คำขอที่ไม่มี token จะคืนแบนเนอร์เวอร์ชันแทน 404 มีประโยชน์เป็นการตรวจสอบเบื้องต้น; ควรปิดในสภาพการผลิต.
UnsafeModefalseเมื่อเป็น true จะข้ามการตรวจสอบความปลอดภัยของ session ของ ASP.NET ในคำขอหน้า. ควรปิดในสภาพการผลิต.
MiddlewarePath"/doconut"ค่าประสานงานสำหรับ endpoint ของหน้า‑ภาพ ถูกตรวจสอบแล้วแต่ไม่ได้สร้างสาขาโดยอัตโนมัติ; ควรรักษาค่าตรงกับการแมป UseDoconut() จริงและ BasePath ของไคลเอนต์.
ResourcesPath"/doconut-res"ตำแหน่งที่ให้บริการทรัพยากร JS/CSS/รูปภาพที่ฝังอยู่.
LicensePath"" (empty string)เส้นทางไปยังไฟล์ใบอนุญาต. ค่าว่างหมายถึงให้ลองแหล่งต่อไปแล้วทำการค้นหาอัตโนมัติ.
LicenseContent"" (empty string)เนื้อหาใบอนุญาตดิบ — มาจากตัวแปรสภาพแวดล้อม, ตัวจัดการความลับ, หรือฐานข้อมูล.
LicenseStreamnullใบอนุญาตเป็นสตรีม, อ่านครั้งเดียวเมื่อเริ่มต้น.
ResetLicensefalseแฟล็กความเข้ากันได้ที่สงวนไว้. เซอร์วิส .NET 8 ปัจจุบันอ่านใบอนุญาตระหว่าง AddDoconut(); รีสตาร์ทแอปหลังจากเปลี่ยนใบอนุญาต.

ลำดับความสำคัญของใบอนุญาตเมื่อกำหนดแหล่งมากกว่าหนึ่ง: LicenseStream มีลำดับสูงกว่า LicenseContent สูงกว่า LicensePath สูงกว่า auto-search — ดูที่ การตั้งค่าใบอนุญาต.

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

ขั้นตอนต่อไป

หน้านี้เป็นประโยชน์หรือไม่?