การตั้งค่าใบอนุญาต
ที่ที่ Doconut มองหาไฟล์ใบอนุญาตของคุณ
แม้ไม่มีใบอนุญาต Doconut ยังสามารถแสดงเอกสารได้ — ทุกหน้าจะมีลายน้ำการประเมินผล หน้านี้อธิบายวิธีสี่วิธีในการจัดหาใบอนุญาต และลำดับความสำคัญที่แน่นอนเมื่อมีการตั้งค่ามากกว่าหนึ่งวิธี
สี่วิธีในการจัดหาใบอนุญาต
มีทั้งหมดสี่วิธี: แหล่งที่มาชัดเจนสามแหล่งบน DoconutOptions — สตรีม, เนื้อหาดิบ, หรือเส้นทางไฟล์ — พร้อมกับการค้นหาอัตโนมัติเมื่อไม่มีการตั้งค่าใด ๆ เมื่อมีการตั้งค่ามากกว่าหนึ่งแหล่ง ลำดับความสำคัญจะเป็นตามที่ระบุ:
LicenseStream ชนะ LicenseContent ชนะ LicensePath ชนะ การค้นหาอัตโนมัติ.
ตามพาธ
LicensePath ถูกส่งไปยัง File.Exists ตามที่กำหนดไว้โดยตรง. เส้นทางสัมพัทธ์จะถูกแก้ไขโดยอ้างอิงกับ ไดเรกทอรีทำงานปัจจุบัน ของกระบวนการ — ไม่ใช่โฟลเดอร์โปรเจกต์ของคุณ, และไม่ใช่โฟลเดอร์ที่ Program.cs อยู่. หากเส้นทางไม่สามารถแก้ไขได้ Doconut จะไม่โยนข้อผิดพลาดและ ไม่ ย้อนกลับไปใช้การค้นหาอัตโนมัติ — มันจะเพียงแค่ไม่โหลดใบอนุญาตและตัวดูจะแสดงลายน้ำ. การค้นหาอัตโนมัติจะทำงานเฉพาะเมื่อไม่มีการตั้งค่าใด ๆ ของ LicensePath, LicenseContent หรือ LicenseStream. ไฟล์ใบอนุญาตของแต่ละปลั๊กอินในโฟลเดอร์เดียวกัน (Doconut.Viewer.<Capability>.lic) จะถูกอ่านพร้อมกับมัน, ดังนั้น LicensePath และ AddPlugin<...>() จะทำงานร่วมกันเมื่อใบอนุญาตปลั๊กอินอยู่ข้างๆ ใบอนุญาตหลัก.
ควรใช้เส้นทางแบบเต็ม (เช่น สร้างจาก IWebHostEnvironment.WebRootPath หรือ AppContext.BaseDirectory), หรือข้าม LicensePath ทั้งหมดและพึ่งพาการค้นหาอัตโนมัติต่อไปด้านล่าง.
builder.Services.AddDoconut(options =>
{
options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});ตามสตรีม
LicenseStream จะถูกอ่านครั้งเดียวเมื่อเริ่มต้น — มีประโยชน์เมื่อใบอนุญาตมาจากที่เก็บความลับแทนไฟล์บนดิสก์.
// ลำดับความสำคัญ: LicenseStream > LicenseContent > LicensePath > auto-search.
builder.Services.AddDoconut(options =>
{
options.LicenseStream = licenseStream;
});ตามเนื้อหา
LicenseContent ยอมรับข้อความใบอนุญาตโดยตรง — จากตัวแปรสภาพแวดล้อม, ฐานข้อมูล, หรือผู้จัดการความลับ:
// License XML จากฐานข้อมูล, ตัวแปรสภาพแวดล้อม, หรือผู้จัดการความลับ —
// ไม่มีไฟล์บนดิสก์. ถูกเอาชนะได้เฉพาะโดย LicenseStream.
builder.Services.AddDoconut(options =>
{
options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});การค้นหาอัตโนมัติ
หากไม่ได้กำหนดแหล่งที่มาชัดเจนทั้งสาม, Doconut จะค้นหาใบอนุญาตด้วยตนเอง:
// ไม่ต้องกำหนดค่าใด ๆ, และ Doconut จะค้นหาไลเซนส์ด้วยตนเอง, ในสองโฟลเดอร์ต่อไปนี้เท่านั้น:
// 1. {CurrentDirectory}/wwwroot
// 2. {AppContext.BaseDirectory}/wwwroot (wwwroot ภายในโฟลเดอร์ผลลัพธ์การสร้าง)
// มันจะมองหา Doconut.lic ก่อน; หากไม่มี, Doconut.Viewer.lic พร้อมกับไฟล์ใด ๆ
// ไฟล์ Doconut.Viewer.<Capability>.lic ตามแต่ละปลั๊กอิน.
builder.Services.AddDoconut();โฟลเดอร์สำรวจตามลำดับ, และชื่อไฟล์ที่ค้นหา:
1. {CurrentDirectory}/wwwroot
2. {AppContext.BaseDirectory}/wwwroot
Filenames, in order (each one looked for in folder 1, then folder 2):
Doconut.lic — legacy all-in-one license; if found, nothing else is read
Doconut.Viewer.lic — base viewer license
Doconut.Viewer.<Capability>.lic — per-plugin licenses, read only when Doconut.Viewer.lic was foundไม่มีอะไรนอกโฟลเดอร์ wwwroot ที่จะถูกอ่าน: .lic ในโฟลเดอร์ผลลัพธ์เอง, หรือใน wwwroot/lib, จะถูกละเลย.
คัดลอกใบอนุญาตไปยังโฟลเดอร์ผลลัพธ์ของคุณ
เมื่อกระบวนการไม่ได้ทำงานจากโฟลเดอร์โปรเจกต์ — แอปที่เผยแพร่, IIS, คอนเทนเนอร์, ตัวรันเทสต์ — การสำรวจครั้งแรกจะพลาด, และการสำรวจครั้งที่สอง, {AppContext.BaseDirectory}/wwwroot, ต้องค้นหาไฟล์นั้น. เป้าหมาย MSBuild นี้จะคัดลอกใบอนุญาตไปที่นั่นทุกครั้งที่สร้าง:
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
<ItemGroup>
<DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
<StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
</ItemGroup>
<!-- ลบก่อน, เพื่อให้การเปลี่ยนชื่อหรือการลบไฟล์ .lic ใน wwwroot จะถูกลบออกจากผลลัพธ์ด้วย. -->
<Delete Files="@(StaleOutputLicenses)" />
<Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>ตำแหน่งปลายทางต้องเป็น $(OutDir)wwwroot: .lic ที่คัดลอกไปยังรากของผลลัพธ์จะไม่ถูกพบโดยการค้นหาอัตโนมัติ. ตัวอย่าง LicensePath บนหน้านี้ชี้ไปยังตำแหน่งเดียวกัน.
อย่าให้ไฟล์
.licอยู่ในระบบควบคุมเวอร์ชัน — ปล่อยมันไว้ข้างแอป, หรือแทรกใบอนุญาตผ่านLicenseContentหรือLicenseStreamจากที่เก็บความลับของคุณ.
จะเกิดอะไรขึ้นหากไม่มีใบอนุญาต
การไม่มีใบอนุญาตจะไม่ทำให้เกิดข้อยกเว้น. AddDoconut() ทำงานสำเร็จ, แอปเริ่มทำงาน, และผู้ชมทำงาน — แต่ทุกหน้าจะมีลายน้ำการประเมินและไม่มีความสามารถเสริมใด ๆ ที่ได้รับการอนุญาต.
ไฟล์ใบอนุญาตที่พบแต่ถูกปฏิเสธจะแตกต่างออกไป. ลายเซ็นที่ไม่ถูกต้อง, การดัดแปลง, การขึ้นบัญชีดำ, หรือการสร้างที่อยู่นอกช่วงเวอร์ชันของใบอนุญาตทำให้ OpenDocumentAsync โยนข้อยกเว้น LicenseException พร้อมกับ License.RejectionMessage. ใบอนุญาต Temporary ที่หมดอายุจะดำเนินการต่อในโหมดมีลายน้ำ. ใบอนุญาตที่ชำระเงินซึ่งวันหมดอายุการสมัครสมาชิกผ่านไปแล้วยังคงทำงานได้อย่างสมบูรณ์และพร้อมความสามารถของมันบนทุกการสร้างที่ปล่อยก่อนวันนั้น.
ปลั๊กอินต้องการความสามารถ
การลงทะเบียนปลั๊กอินที่ไม่มีสิทธิ์ที่สอดคล้องกันจะแตกต่าง: สำหรับกรณีไม่มีใบอนุญาต, ไฟล์ legacy TRIAL, หรือใบอนุญาตที่ชำระเงินที่ไม่มีความสามารถนั้น, AddDoconut() โยนข้อยกเว้น InvalidOperationException, ทำให้แอปไม่เริ่มทำงาน. ตัวอย่างเช่น การลงทะเบียนปลั๊กอิน Converter โดยไม่มีใบอนุญาตที่ให้สิทธิ์ Converter:
InvalidOperationException: The Converter plugin is registered via AddPlugin but no active
license grants Converter. Remove the AddPlugin<...>() call or install a license (or
trial/demo) that includes Converter.ข้อความบอกวิธีแก้โดยตรง: หรือเอาการเรียก options.AddPlugin<...>() สำหรับปลั๊กอินนั้นออก, หรือทำการติดตั้งใบอนุญาตที่ชำระเงินหรือใบอนุญาต Temporary/Demo (NFR) ที่ใช้งานได้ซึ่งให้ความสามารถนั้น. การลงทะเบียน Temporary จะได้รับอนุญาตให้คงอยู่หลังวันหมดอายุเพื่อให้แอปที่กำหนดค่าไว้แล้วสามารถทำงานในระดับต่ำลงในขณะรันไทม์แทนที่จะพังระหว่างการรีสตาร์ท; เมื่อหมดอายุ ความสามารถของมันยังคงถูกยกเลิก.
ตรวจสอบใบอนุญาตที่โหลด
ใช้ IDoconutLicenseService, แหล่งข้อมูลที่เป็นความจริงเดียวกันที่ SDK ใช้, เพื่อเปิดเผย endpoint การวินิจฉัยที่ผ่านการตรวจสอบหรือเพื่อควบคุมฟีเจอร์ฟลัก. อย่าคืนค่าเนื้อหาใบอนุญาตหรือคีย์.
app.MapGet("/api/doconut/license", (IDoconutLicenseService license) => Results.Ok(new
{
viewer = license.IsViewerLicensed || license.IsTemporary,
temporary = license.IsTemporary,
search = license.IsCapabilityGranted(LicenseCapability.Search),
annotation = license.IsCapabilityGranted(LicenseCapability.Annotation),
converter = license.HasConverter,
dicom = license.HasDicom
}));ใบอนุญาตจะถูกอ่านในระหว่างการลงทะเบียน AddDoconut(). ResetLicense ปัจจุบันเป็นคุณสมบัติความเข้ากันได้ที่ไม่มีเส้นทางรีโหลดที่ทำงาน, ดังนั้นการเปลี่ยนไฟล์ใบอนุญาตต้องรีสตาร์ทแอปพลิเคชัน.
ตารางการแก้ไขปัญหา
| อาการ | สาเหตุที่เป็นไปได้ | ตรวจสอบ |
|---|---|---|
| ตัวดูทำงานแต่ทุกหน้ามีลายน้ำ | ไม่ได้โหลดใบอนุญาต, หรือใบอนุญาต Temporary หมดอายุ | แก้ไข IDoconutLicenseService; ตรวจสอบไดเรกทอรีผลลัพธ์และไดเรกทอรีทำงานของกระบวนการ |
AddDoconut() โยนข้อยกเว้นสำหรับปลั๊กอิน | ใบอนุญาตไม่ได้ให้ความสามารถของปลั๊กอินนั้น | ตรวจสอบ IsCapabilityGranted(...) และลบการลงทะเบียนที่คุณไม่ได้ซื้อ |
| เส้นทางสัมพัทธ์ที่กำหนดทำงานในเครื่องท้องถิ่นแต่ไม่ทำงานใน IIS/คอนเทนเนอร์ | ไดเรกทอรีทำงานของกระบวนการเปลี่ยนไป | ใช้ AppContext.BaseDirectory หรือเส้นทางแบบเต็ม |
ไฟล์ .lic ที่แทนที่ไม่มีผล | บริการใบอนุญาตแบบ singleton ถูกสร้างแล้ว | รีสตาร์ทแอปพลิเคชัน |
OpenDocumentAsync โยนข้อยกเว้น LicenseException | ลายเซ็น, โดเมน, ช่วงเวอร์ชัน, รายการดำ, หรือประตูรันไทม์ของปลั๊กอิน ปฏิเสธใบอนุญาต | อ่านข้อความข้อยกเว้น/การปฏิเสธโดยไม่เปิดเผยต่อไคลเอ็นต์ที่ไม่เชื่อถือ |
ขั้นตอนต่อไป
- การให้สิทธิ์ — ความสามารถ, ระดับใบอนุญาต, และการตรวจสอบสิ่งที่โหลดในขณะรันไทม์.
- การแก้ไขปัญหา — ลายน้ำ, ใบอนุญาตที่ถูกปฏิเสธ, และข้อผิดพลาดของความสามารถ.
หน้านี้เป็นประโยชน์หรือไม่?