การตั้งค่าใบอนุญาต

ที่ที่ 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 อย่างเต็มที่และพึ่งพาการค้นหาอัตโนมัติต่อไปด้านล่าง.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});

ตามสตรีม

LicenseStream จะถูกอ่านครั้งเดียวเมื่อเริ่มต้น — มีประโยชน์เมื่อใบอนุญาตมาจากที่เก็บความลับแทนไฟล์บนดิสก์.

csharp
// ลำดับความสำคัญ: LicenseStream > LicenseContent > LicensePath > auto-search.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

ตามเนื้อหา

LicenseContent ยอมรับข้อความใบอนุญาตโดยตรง — จากตัวแปรสภาพแวดล้อม, ฐานข้อมูล, หรือผู้จัดการความลับ:

csharp
// License XML จากฐานข้อมูล, ตัวแปรสภาพแวดล้อม, หรือ secret manager —
// ไม่มีไฟล์บนดิสก์. แค่ LicenseStream เท่านั้นที่เหนือกว่า.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

การค้นหาอัตโนมัติ

ไม่กำหนดค่าแหล่งที่มาชัดเจนสามแหล่งใด ๆ, แล้ว Doconut จะค้นหาใบอนุญาตด้วยตนเอง:

csharp
// ไม่ต้องกำหนดค่าใด ๆ, และ Doconut จะค้นหาไลเซนส์ด้วยตนเอง, ในสองโฟลเดอร์ต่อไปนี้เท่านั้น:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot ภายในโฟลเดอร์ผลลัพธ์การสร้าง)
// มันจะมองหา Doconut.lic ก่อน; หากไม่มี, จะมองหา Doconut.Viewer.lic พร้อมกับ
// ไฟล์ per-plugin Doconut.Viewer.<Capability>.lic
builder.Services.AddDoconut();

โฟลเดอร์สำรวจ, ตามลำดับ, และชื่อไฟล์ที่ค้นหา:

text
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 นี้จะคัดลอกใบอนุญาตไปที่นั่นในทุกการสร้าง:

xml
<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:

text
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 การวินิจฉัยที่ผ่านการรับรองหรือเพื่อควบคุมฟีเจอร์ฟลัก. อย่าให้คืนเนื้อหาใบอนุญาตหรือคีย์.

csharp
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ลายเซ็น, โดเมน, ช่วงเวอร์ชัน, รายการดำ, หรือประตูรันไทม์ของปลั๊กอินปฏิเสธใบอนุญาตอ่านข้อความข้อยกเว้น/การปฏิเสธโดยไม่เปิดเผยต่อคลไอเอนต์ที่ไม่เชื่อถือ

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

  • การให้สิทธิ์ — ความสามารถ, ระดับใบอนุญาต, และการตรวจสอบสิ่งที่โหลดในเวลารัน.
  • การแก้ไขปัญหา — ลายน้ำ, ใบอนุญาตที่ถูกปฏิเสธ, และข้อผิดพลาดของความสามารถ.

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