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

ตำแหน่งที่ Doconut มองหาไฟล์ใบอนุญาตของคุณภายใต้ IIS

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

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

มีแหล่งที่มาชัดเจนสามแหล่งบน DoconutOptions — เส้นทางไฟล์, สตรีม, หรือเนื้อหาดิบ — พร้อมการค้นหาอัตโนมัติเมื่อไม่มีการตั้งค่าใด ๆ ทั้งหมดจะถูกอ่านหนึ่งครั้งใน DoconutHost.Initialize. เมื่อมีการตั้งค่ามากกว่าหนึ่งค่า ลำดับความสำคัญเป็นดังนี้:

LicenseStream มีลำดับเหนือ LicenseContent มีลำดับเหนือ LicensePath มีลำดับเหนือการค้นหาอัตโนมัติ.

ตามเส้นทาง

ให้ LicensePath เส้นทางเต็ม หนทางสัมพัทธ์จะถูกแก้ไขโดยอ้างอิงจากไดเรกทอรีปัจจุบันของกระบวนการ, และภายใต้ IIS นั้นคือโฟลเดอร์ของกระบวนการทำงานเอง, ไม่ใช่ไซต์ของคุณ. HostingEnvironment.MapPath แปลงเส้นทางสัมพันธ์กับไซต์ให้เป็นเส้นทางเต็ม:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});

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

ตามสตรีม

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

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

ตามเนื้อหา

LicenseContent รับข้อความใบอนุญาตโดยตรง — จากตัวแปรสภาพแวดล้อม, ฐานข้อมูล, หรือที่เก็บความลับ — ดังนั้นไม่จำเป็นต้องปรับใช้ไฟล์ใบอนุญาตกับไซต์.

csharp
// License XML จากฐานข้อมูล, ตัวแปรสภาพแวดล้อม หรือที่เก็บความลับ -
// ไม่มีไฟล์บนดิสก์. ถูกเอาชนะได้เฉพาะโดย LicenseStream.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

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

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

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

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

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

ภายใต้ IIS และ IIS Express, AppContext.BaseDirectory คือ โฟลเดอร์รากของไซต์ — โฟลเดอร์ที่เก็บ Web.config — ไม่ใช่โฟลเดอร์ bin ของมัน. ดังนั้นใบอนุญาตควรอยู่ใน wwwroot ใต้รากของไซต์:

text
MySite\
  Web.config
  Global.asax
  bin\
  wwwroot\
    Doconut.Viewer.lic
    Doconut.Viewer.Converter.lic

ในโครงการ, เก็บ wwwroot\*.lic ข้าง ๆ Web.config และปรับใช้โฟลเดอร์พร้อมกับไซต์. ไม่จำเป็นต้องคัดลอกในขั้นตอนการสร้างใด ๆ. .lic ที่อื่น — ใน bin\, ข้าง ๆ Web.config, หรือในโฟลเดอร์ย่อยของ wwwroot — จะไม่ถูกอ่านเลย.

อย่าเก็บไฟล์ .lic ไว้ในระบบควบคุมเวอร์ชัน. ปรับใช้ไฟล์เหล่านั้นพร้อมกับไซต์, หรือจัดหาใบอนุญาตผ่าน LicenseContent หรือ LicenseStream จากที่เก็บความลับของคุณ.

จะเกิดอะไรขึ้นหากไม่มีใบอนุญาต

ใบอนุญาตที่หายไปจะไม่ทำให้เกิดข้อยกเว้น. DoconutHost.Initialize ทำงานสำเร็จ, เว็บไซต์เริ่มต้น, และตัวดูทำงาน, แต่ทุกหน้าจะมีลายน้ำการประเมินและไม่มีความสามารถเสริมใด ๆ ที่ได้รับอนุญาต.

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

ปลั๊กอินต้องการใบอนุญาตของมันเมื่อตั้งค่าเริ่มต้น

การลงทะเบียนปลั๊กอินที่ความสามารถของมันไม่ได้รับการอนุญาตจากใบอนุญาตใด ๆ จะทำให้แอปพลิเคชันหยุดทำงานเมื่อตั้งค่าเริ่มต้น. DoconutHost.Initialize โยนข้อยกเว้นใน Application_Start:

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.

ภายใต้ System.Web, คุณจะไม่เห็นข้อความนั้นในเบราว์เซอร์. ทุกคำขอไปยังไซต์จะตอบกลับเป็น 500 ว่างเปล่า — ไม่มีหน้าข้อผิดพลาด, ไม่มี stack trace, ไม่มีอะไรในบันทึก IIS. ข้อยกเว้นจะถูกบันทึกเฉพาะใน บันทึกเหตุการณ์ Windows (บันทึก Application, แหล่งที่มาจาก ASP.NET). หากทั้งไซต์หยุดตอบสนองทันทีหลังจากคุณเพิ่มบรรทัด AddPlugin, ตรวจสอบไฟล์ใบอนุญาตใน wwwroot ก่อนโค้ด: Doconut.Viewer.<Capability>.lic ของปลั๊กอินต้องอยู่ข้าง ๆ Doconut.Viewer.lic, และหากไม่มีใบอนุญาตฐานไฟล์ปลั๊กอินจะไม่ถูกอ่านเลย.

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

IDoconutLicenseService เป็นแหล่งความจริงเดียวกันที่ SDK ใช้. แก้ไขจาก DoconutHost.Services เพื่อเปิดเผย endpoint การวินิจฉัยที่ผ่านการตรวจสอบหรือควบคุมฟีเจอร์ — อย่าเคยคืนเนื้อหาใบอนุญาต:

csharp
// GET /License/Status
public ActionResult Status()
{
    var license = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(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
    }, JsonRequestBehavior.AllowGet);
}

ใบอนุญาตจะถูกอ่านหนึ่งครั้งใน DoconutHost.Initialize. หลังจากเปลี่ยนไฟล์ใบอนุญาต, รีไซเคิล application pool (หรือแก้ไข Web.config) เพื่อให้ Application_Start ทำงานอีกครั้ง.

การแก้ไขปัญหา

อาการสาเหตุที่เป็นไปได้ตรวจสอบ
ตัวดูทำงานแต่ทุกหน้ามีลายน้ำไม่พบใบอนุญาตไฟล์ .lic อยู่ใน <site root>\wwwroot หรือไม่? เรียก endpoint สถานะด้านบน
ทุกคำขอตอบกลับเป็น 500 ว่างเปล่าทันทีหลังจากเพิ่มปลั๊กอินปลั๊กอินที่ลงทะเบียนไม่มีใบอนุญาตที่ให้สิทธิ์บันทึกเหตุการณ์ Windows, แหล่งที่มาจาก ASP.NET; .lic ของปลั๊กอินอยู่ข้าง ๆ Doconut.Viewer.lic
LicensePath ทำงานบนเครื่องของคุณแต่ไม่ทำงานบนเซิร์ฟเวอร์เส้นทางสัมพัทธ์ที่แก้ไขตามโฟลเดอร์กระบวนการทำงานสร้างด้วย HostingEnvironment.MapPath("~/wwwroot/...")
ไฟล์ .lic ที่แทนที่ไม่มีผลใบอนุญาตถูกอ่านเมื่อแอปพลิเคชันเริ่มต้นรีไซเคิล application pool
OpenDocumentAsync โยน LicenseExceptionพบใบอนุญาตแต่ถูกปฏิเสธอ่านข้อความข้อยกเว้น; อย่าแสดงให้กับลูกค้าที่ไม่เชื่อถือ

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

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