การติดตั้ง

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

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

ความต้องการ

แพ็กเกจทำงานบนแพลตฟอร์มต่อไปนี้:

แพลตฟอร์มรองรับ
Windows x64 / x86ใช่
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:8.0 image)ใช่
Alpine and other musl-based distributionsไม่ใช่
macOSไม่ใช่

บน Linux ให้ติดตั้งไลบรารีการกำหนดค่าแบบอักษรก่อนที่เอกสารแรกจะเปิด:

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

บน RHEL, Fedora และดิสทริบิวชันที่คล้ายกัน แพ็กเกจเป็น fontconfig (dnf install -y fontconfig) นั่นเป็นแพ็กเกจระบบเดียวที่ Doconut ต้องการ: ไลบรารีเนทีฟที่ใช้จะมาพร้อมกับแพ็กเกจ NuGet, และ libgdiplus ไม่จำเป็น หน้าจะถูกวาดด้วยแบบอักษรที่ติดตั้งบนเซิร์ฟเวอร์ ดังนั้นดูที่ Troubleshooting สำหรับแบบอักษรและข้อความแสดงข้อผิดพลาดของ Linux.

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

bash
dotnet add package Doconut.NET8

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

bash
dotnet add package Doconut.NET8 --version 26.10.0

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

ลงทะเบียน Doconut

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

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

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // สถานะเซสชันต้องการแคช (MVC/Razor Pages มีการเพิ่มแล้ว)
builder.Services.AddSession(); // ความปลอดภัยของเอกสาร Doconut พึ่งพา session state ของ ASP.NET

app.UseSession();          // เรียก UseSession() ก่อน UseDoconut()
app.UseDoconutResources(); // ต้องลงทะเบียนก่อน UseDoconut()
app.Map("/doconut", branch => branch.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 8 ปัจจุบันอ่านลิขสิทธิ์ระหว่าง AddDoconut(); รีสตาร์ทแอปหลังจากเปลี่ยนลิขสิทธิ์.
MaxConcurrentEditorSessions200จำนวนสูงสุดของเซสชันเอดิเตอร์สด (เอกสารที่เปิดด้วย DocOptions.EditMode). หากเกินค่านี้, เซสชันเอดิเตอร์ที่ไม่ได้ใช้เป็นเวลานานที่สุดจะถูกปิด. เซสชันผู้ดูปกติจะไม่ถูกนับ. 0 หรือค่าติดลบหมายถึงไม่มีขีดจำกัด.
EditorSnapshotEveryOps50เมื่อเปิดการคงสภาพเอดิเตอร์ (AddDoconutEditorPersistence), ทำ snapshot เอกสารสดทุก N การเปลี่ยนแปลงที่บันทึกไว้. 0 หรือค่าติดลบจะไม่ทำ snapshot ระหว่างเซสชัน. ไม่มีผลเมื่อการคงสภาพถูกปิด.

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

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // ประสานงานกับการแมปแอปและ BasePath ของไคลเอนต์
    options.ResourcesPath   = "/doconut-res"; // ตำแหน่งที่ JS/CSS/รูปภาพของ viewer ถูกให้บริการจาก
    options.UnsafeMode      = false;          // รักษาความปลอดภัยของ session ไว้
    options.ShowDoconutInfo = false;
});

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

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

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