การติดตั้ง

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

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

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

bash
dotnet add package Doconut.NET6

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

bash
dotnet add package Doconut.NET6 --version 26.7.0

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

ระบุการบูรณาการก่อนอัปเกรด

ID ของแพ็กเกจ Doconut.NET6 ถูกใช้ทั้งในแบบคลาสสิกและการบูรณาการ .NET 6 ปัจจุบัน อย่าเลือกเอกสารจากชื่อแพ็กเกจอย่างเดียว:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), OpenDocument(...) แบบ synchronous, และสคริปต์ตัวดูที่คัดลอกด้วยตนเองบ่งชี้ถึง การบูรณาการแบบคลาสสิก;
  • AddDoconut(), UseDoconutResources(), Viewer ที่ฉีดเข้าไป, และ OpenDocumentAsync(...) บ่งชี้ถึงการบูรณาการปัจจุบันที่อธิบายไว้ที่นี่.

คู่มือการตั้งค่าแบบคลาสสิกที่แปลแล้ว classic setup manual ยังพร้อมใช้งาน ใช้ คู่มือการย้าย เพื่อเปลี่ยนรุ่น; การอัปเดตแพ็กเกจปกติจะไม่แปลงการเริ่มต้น, อายุการใช้งานของตัวดู, หรือทรัพยากรเบราว์เซอร์โดยอัตโนมัติ.

ลงทะเบียน Doconut

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

การเรียก 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 จะข้ามการตรวจสอบความปลอดภัยของ ASP.NET-session ในคำขอหน้า ปิดในสภาพแวดล้อมการผลิต.
MiddlewarePath"/doconut"ค่าประสานงานสำหรับ endpoint ของหน้า-รูปภาพ จะถูกตรวจสอบ แต่ไม่ได้ทำการเมานท์สาขาโดยตัวเอง; ควรรักษาความสอดคล้องกับการแมป UseDoconut() จริงและ BasePath ของไคลเอนต์.
ResourcesPath"/doconut-res"ตำแหน่งที่ให้บริการทรัพยากร JS/CSS/รูปภาพที่ฝังอยู่.
LicensePath"" (empty string)เส้นทางไปยังไฟล์ใบอนุญาต ค่าว่างหมายถึงจะไปยังแหล่งต่อไปแล้วทำการค้นหาอัตโนมัติ.
LicenseContent"" (empty string)เนื้อหาใบอนุญาตดิบ — มาจากตัวแปรสภาพแวดล้อม, ตัวจัดการความลับ, หรือฐานข้อมูล.
LicenseStreamnullใบอนุญาตเป็นสตรีม, อ่านครั้งเดียวที่การเริ่มต้น.
ResetLicensefalseแฟล็กความเข้ากันได้ที่สงวนไว้ บริการ .NET 6 ปัจจุบันอ่านใบอนุญาตระหว่าง AddDoconut(); รีสตาร์ทแอปหลังจากเปลี่ยนใบอนุญาต.

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

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

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

  • Quick Start — เปิดเอกสารแรกของคุณและเรนเดอร์ในเบราว์เซอร์.
  • License Setup — ที่ที่ Doconut มองหาไฟล์ใบอนุญาตของคุณ.

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