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

หากไม่มีใบอนุญาต, Doconut ยังสามารถแสดงเอกสารได้ — แต่ทุกหน้าจะมีลายน้ำการประเมินผลอยู่ หน้านี้อธิบายวิธีสี่วิธีในการจัดหาใบอนุญาต, และลำดับความสำคัญที่แน่นอนเมื่อมีการตั้งค่ามากกว่าหนึ่งวิธี

ใบอนุญาตจะถูกโหลด หนึ่งครั้ง, ระหว่างการเรียก AddDoconut() นี่เป็นการเปลี่ยนแปลงจากไลบรารี .NET Standard ก่อนหน้า, ที่ซึ่งใบอนุญาตถูกส่งให้กับอินสแตนซ์ Viewer หรือกำหนดผ่านการเรียกแบบสแตติก Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...) วิธีเหล่านั้นไม่ได้เป็นกลไกการเริ่มต้นในรุ่นนี้ — ดูที่ คู่มือการย้าย.

สี่วิธีในการจัดหาใบอนุญาต

มีทั้งหมดสี่วิธี: แหล่งที่มาชัดเจนสามแหล่งบน 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 รับข้อความใบอนุญาตโดยตรง — จากตัวแปรสภาพแวดล้อม, ฐานข้อมูล, หรือผู้จัดการความลับ:

// 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, พร้อมกับไฟล์ใด ๆ ที่เป็น per-capability
// ไฟล์ Doconut.Viewer.<Capability>.lic ที่อยู่ข้างๆ
builder.Services.AddDoconut();

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

1. {CurrentDirectory}/wwwroot
2. {AppContext.BaseDirectory}/wwwroot

ชื่อไฟล์ (ตรวจสอบในแต่ละโฟลเดอร์ตามลำดับ):
  Doconut.lic                          — ใบอนุญาตผู้ชมพื้นฐาน (ตรวจสอบเป็นอันดับแรก)
  Doconut.Viewer.lic                   — ใบอนุญาตผู้ชมพื้นฐาน
  Doconut.Viewer.<Capability>.lic      — ใบอนุญาตตามความสามารถ, อยู่ข้างๆ ใบอนุญาตหลัก

ไม่มีอะไรนอกโฟลเดอร์ wwwroot ถูกอ่าน: .lic ที่อยู่ในโฟลเดอร์ผลลัพธ์เอง, หรือใน wwwroot/lib, จะถูกละเลย

หากคุณเคยส่ง List<string> ของเส้นทางใบอนุญาตไปยังคอนสตรัคเตอร์ของ Viewer — หนึ่งต่อความสามารถ — ให้เก็บไฟล์คู่เหล่านั้นไว้ข้าง Doconut.Viewer.lic และให้การค้นหาอัตโนมัติดึงขึ้นมา ไม่มีตัวเลือกรายการเส้นทางใน DoconutOptions

คัดลอกใบอนุญาตไปยังโฟลเดอร์ผลลัพธ์ของคุณ

เมื่อกระบวนการไม่ได้ทำงานจากโฟลเดอร์โครงการ — แอปที่เผยแพร่, IIS, คอนเทนเนอร์, ตัวรันเทสต์ — การตรวจสอบครั้งแรกจะพลาด, และการตรวจสอบครั้งที่สอง, {AppContext.BaseDirectory}/wwwroot, จะต้องค้นหาไฟล์นั้น SDK ของตัวเองมีแอปทดสอบที่คัดลอกใบอนุญาตไปที่นั่นในทุกการสร้างด้วยเป้าหมาย 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 ใบอนุญาตที่หมดอายุตามปฏิทินโดยไม่มีข้อความปฏิเสธจะยังคงทำงานในโหมดลายน้ำต่อไป

ปลั๊กอินต้องการความสามารถ

การลงทะเบียนปลั๊กอินโดยไม่มีสิทธิ์ที่สอดคล้องกันจะแตกต่าง: สำหรับใบอนุญาตที่หายไป, ไฟล์ 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) ที่ยังใช้งานอยู่และให้สิทธิ์นั้น การลงทะเบียนแบบชั่วคราวได้รับอนุญาตให้คงอยู่หลังจากวันหมดอายุเพื่อให้แอปที่ตั้งค่าไว้แล้วสามารถทำงานในโหมดลดคุณภาพได้ในขณะรันแทนที่จะพังระหว่างการรีสตาร์ท; หลังจากหมดอายุ ความสามารถของมันยังคงถูกยกเลิก

ตรวจสอบใบอนุญาตที่โหลดแล้ว

ใช้ 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 ปัจจุบันเป็นคุณสมบัติความเข้ากันได้ที่ไม่มีเส้นทางรีโหลดที่ใช้งานอยู่ ดังนั้นการแทนที่ไฟล์ใบอนุญาตต้องรีสตาร์ทแอปพลิเคชัน

เมทริกซ์การแก้ไขปัญหา

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

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