Cài đặt Giấy phép
Nơi Doconut tìm kiếm tệp giấy phép của bạn trên IIS
Nếu không có giấy phép, Doconut vẫn hiển thị tài liệu — mỗi trang chỉ có một dấu nước đánh giá. Trang này trình bày bốn cách cung cấp giấy phép trong Global.asax, nơi Doconut tìm kiếm khi bạn không cung cấp gì, và những gì xảy ra khi giấy phép của plugin bị thiếu.
Bốn cách cung cấp giấy phép
Có ba nguồn rõ ràng trên DoconutOptions — một đường dẫn tệp, một luồng, hoặc nội dung thô — cộng với việc tự động khám phá khi không có nào được đặt. Tất cả chúng được đọc một lần, trong DoconutHost.Initialize. Khi có hơn một nguồn được đặt, thứ tự ưu tiên là chính xác:
LicenseStream đánh bại LicenseContent đánh bại LicensePath đánh bại việc khám phá tự động.
Theo đường dẫn
Cung cấp cho LicensePath một đường dẫn đầy đủ. Đường dẫn tương đối được giải quyết dựa trên thư mục hiện tại của tiến trình, và trên IIS thì đó là thư mục của tiến trình worker, không phải trang web của bạn. HostingEnvironment.MapPath chuyển một đường dẫn tương đối với trang web thành một đường dẫn đầy đủ:
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});Nếu tệp không tồn tại, Doconut không ném lỗi và không quay lại việc khám phá tự động: nó không tải bất kỳ giấy phép nào, và trình xem sẽ có dấu nước. Các tệp giấy phép riêng cho mỗi plugin trong cùng thư mục (Doconut.Viewer.<Capability>.lic) được đọc cùng với nó, vì vậy LicensePath và AddPlugin<...>() hoạt động cùng nhau khi các giấy phép plugin nằm bên cạnh giấy phép cơ bản.
Theo luồng
LicenseStream được đọc một lần, khi khởi động — hữu ích khi giấy phép đến từ một tài nguyên nhúng hoặc kho bí mật thay vì một tệp trên đĩa.
// Ưu tiên: LicenseStream > LicenseContent > LicensePath > tự‑tìm kiếm.
Doconut.DoconutHost.Initialize(options =>
{
options.LicenseStream = licenseStream;
});Theo nội dung
LicenseContent nhận trực tiếp văn bản giấy phép — từ biến môi trường, cơ sở dữ liệu, hoặc kho bí mật — vì vậy không cần triển khai tệp giấy phép cùng trang web.
// License XML từ cơ sở dữ liệu, biến môi trường hoặc kho bí mật -
// không có tệp trên đĩa. Chỉ bị LicenseStream vượt qua.
Doconut.DoconutHost.Initialize(options =>
{
options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});Khám phá tự động
Không đặt bất kỳ trong ba tùy chọn, và Doconut sẽ tự tìm kiếm giấy phép:
// Không cấu hình gì, và Doconut sẽ tự tìm kiếm giấy phép, theo thứ tự sau:
// 1. {CurrentDirectory}\wwwroot
// 2. {AppContext.BaseDirectory}\wwwroot (trên IIS: thư mục gốc của site)
// Đầu tiên nó tìm Doconut.lic; nếu thiếu, sẽ tìm Doconut.Viewer.lic cộng với bất kỳ
// các tệp Doconut.Viewer.<Capability>.lic theo từng plugin.
Doconut.DoconutHost.Initialize();Hai thư mục, theo thứ tự, và các tệp được tìm kiếm:
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 foundTrên IIS và IIS Express, AppContext.BaseDirectory là thư mục gốc của trang web — thư mục chứa Web.config — không phải thư mục bin của nó. Vì vậy giấy phép phải nằm trong wwwroot dưới thư mục gốc của trang web:
MySite\
Web.config
Global.asax
bin\
wwwroot\
Doconut.Viewer.lic
Doconut.Viewer.Converter.licTrong dự án, giữ wwwroot\*.lic bên cạnh Web.config và triển khai thư mục cùng trang web. Không cần bước build nào để sao chép nó tới đâu. Một .lic ở bất kỳ nơi nào khác — trong bin\, cạnh Web.config, hoặc trong một thư mục con của wwwroot — sẽ không bao giờ được đọc.
Giữ các tệp
.licra khỏi kiểm soát nguồn. Triển khai chúng cùng trang web, hoặc cung cấp giấy phép quaLicenseContenthoặcLicenseStreamtừ kho bí mật của bạn.
Điều gì xảy ra khi không có giấy phép
Một giấy phép thiếu không gây lỗi. DoconutHost.Initialize thành công, trang web khởi động, và trình xem chạy, nhưng mọi trang đều có dấu nước đánh giá và không có khả năng tùy chọn nào được cấp.
Một tệp giấy phép được tìm thấy nhưng bị từ chối thì khác. Chữ ký không hợp lệ, bị can thiệp, hoặc bản dựng nằm ngoài khoảng thời gian phiên bản của giấy phép khiến OpenDocumentAsync ném LicenseException kèm lý do. Một giấy phép Temporary đã hết hạn vẫn tiếp tục ở chế độ có dấu nước. Một giấy phép trả phí mà ngày đăng ký đã qua vẫn hoạt động, sạch sẽ và với các khả năng của nó, trên mọi bản dựng được phát hành trước ngày đó.
Các plugin cần giấy phép của chúng khi khởi động
Đăng ký một plugin mà khả năng của nó không được giấy phép nào cấp sẽ dừng ứng dụng khi khởi động. DoconutHost.Initialize ném lỗi trong Application_Start:
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.Trong System.Web, bạn sẽ không thấy thông báo đó trong trình duyệt. Mọi yêu cầu tới trang trả về một 500 trống — không có trang lỗi, không có stack trace, không có gì trong nhật ký IIS. Ngoại lệ chỉ được ghi lại trong Windows event log (nhật ký Ứng dụng, nguồn ASP.NET). Nếu toàn bộ trang ngừng phản hồi ngay sau khi bạn thêm một dòng AddPlugin, hãy kiểm tra các tệp giấy phép trong wwwroot trước mã: Doconut.Viewer.<Capability>.lic của plugin phải nằm cạnh Doconut.Viewer.lic, và nếu không có giấy phép cơ bản các tệp plugin sẽ không được đọc.
Xác minh giấy phép đã tải
IDoconutLicenseService là nguồn sự thật giống như SDK sử dụng. Giải quyết nó từ DoconutHost.Services để mở một endpoint chẩn đoán đã xác thực hoặc điều khiển các cờ tính năng — không bao giờ trả lại nội dung giấy phép:
// 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);
}Giấy phép được đọc một lần, trong DoconutHost.Initialize. Sau khi thay thế tệp giấy phép, hãy tái chế pool ứng dụng (hoặc chạm vào Web.config) để Application_Start chạy lại.
Khắc phục sự cố
| Triệu chứng | Nguyên nhân khả dĩ | Kiểm tra |
|---|---|---|
| Trình xem hoạt động nhưng mọi trang đều có dấu nước | Không tìm thấy giấy phép | .lic có ở trong <site root>\wwwroot không? Gọi endpoint trạng thái ở trên |
Mọi yêu cầu trả về một 500 trống ngay sau khi thêm plugin | Plugin đã đăng ký không có giấy phép cấp cho nó | Nhật ký sự kiện Windows, nguồn ASP.NET; .lic của plugin nằm cạnh Doconut.Viewer.lic |
LicensePath hoạt động trên máy của bạn nhưng không trên máy chủ | Một đường dẫn tương đối được giải quyết dựa trên thư mục tiến trình worker | Xây dựng nó với HostingEnvironment.MapPath("~/wwwroot/...") |
Tệp .lic đã thay thế không có hiệu lực | Giấy phép đã được đọc khi ứng dụng khởi động | Tái chế pool ứng dụng |
OpenDocumentAsync ném LicenseException | Giấy phép được tìm thấy nhưng bị từ chối | Đọc thông báo ngoại lệ; không hiển thị cho khách không tin cậy |
Các bước tiếp theo
- Cấp phép — khả năng, và cách kiểm tra chúng tại thời gian chạy.
- Khắc phục sự cố — dấu nước, lỗi khởi động, và các triệu chứng khác.
Trang này có hữu ích không?