การติดตั้ง

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

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

ความต้องการ

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

แพลตฟอร์มรองรับ
Windows x64 / x86ใช่
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim 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 ไม่จำเป็นต้องใช้
ใน Docker ให้เลือกใช้ aspnet:6.0-bookworm-slim (Debian 12): แท็ก aspnet:6.0 เริ่มต้นคือ Debian 11 ซึ่งแหล่งมิลลิเมตรของแพ็กเกจอาจล้มเหลวในการติดตั้ง libfontconfig1 หน้าเหล่านี้ถูกวาดด้วยแบบอักษรที่ติดตั้งบนเซิร์ฟเวอร์ ดังนั้นดูที่ การแก้ไขปัญหา สำหรับแบบอักษรและข้อความแสดงข้อผิดพลาดของ Linux

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

bash
dotnet add package Doconut.NET6

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

bash
dotnet add package Doconut.NET6 --version 26.10.0

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

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

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

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

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

ลงทะเบียน Doconut

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

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

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

app.UseSession();          // เรียก UseSession() ก่อน UseDoconut()
app.UseDoconutResources(); // ต้องลงทะเบียนก่อน UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

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

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

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

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

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

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

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