Cài đặt Giấy phép

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 mô tả bốn cách cung cấp giấy phép, và thứ tự ưu tiên chính xác khi có hơn một cách được thiết lập.

Bốn cách cung cấp giấy phép

Có bốn cách: ba nguồn rõ ràng trên DoconutOptions — một luồng, nội dung thô, hoặc một đường dẫn tệp — cộng với việc khám phá tự động khi không có nào được thiết lập. Khi có hơn một cách được thiết lập, thứ tự ưu tiên là như sau:

LicenseStream thắng LicenseContent thắng LicensePath thắng tự động tìm kiếm.

Bằng đường dẫn

LicensePath được truyền cho File.Exists chính xác như đã cho. Một đường dẫn tương đối được giải quyết dựa trên thư mục làm việc hiện tại của tiến trình — không phải thư mục dự án của bạn, và không phải thư mục mà Program.cs nằm trong. Nếu đường dẫn không giải quyết được, Doconut không ném lỗi và không quay lại tự động tìm kiếm — nó chỉ đơn giản là không tải giấy phép và trình xem sẽ có dấu nước. Tự động tìm kiếm chỉ chạy khi không có LicensePath, LicenseContent, hoặc LicenseStream nào được thiết lập. Các tệp giấy phép per‑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.

Ưu tiên sử dụng đường dẫn tuyệt đối (ví dụ được xây dựng từ IWebHostEnvironment.WebRootPath hoặc AppContext.BaseDirectory), hoặc bỏ qua hoàn toàn LicensePath và dựa vào việc khám phá tự động bên dưới.

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

Bằng luồng

LicenseStream được đọc một lần khi khởi động — hữu ích khi giấy phép đến từ kho bí mật thay vì một tệp trên đĩa.

// Thứ tự ưu tiên: LicenseStream > LicenseContent > LicensePath > tự động tìm kiếm.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

Bằng nội dung

LicenseContent chấp nhận văn bản giấy phép trực tiếp — từ biến môi trường, cơ sở dữ liệu, hoặc trình quản lý bí mật:

// License XML từ cơ sở dữ liệu, biến môi trường, hoặc trình quản lý bí mật —
// không có tệp trên đĩa. Chỉ bị LicenseStream vượt qua.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

Khám phá tự động

Không cấu hình bất kỳ ba nguồn rõ ràng nào, 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 trong chính nó, chỉ trong hai thư mục sau:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot trong thư mục đầu ra của bản dựng)
// Nó sẽ tìm Doconut.lic trước, sau đó Doconut.Viewer.lic, cộng thêm bất kỳ plugin nào
// các tệp Doconut.Viewer.<Capability>.lic nằm bên cạnh nó.
builder.Services.AddDoconut();

Các thư mục dò, theo thứ tự, và các tên tệp được tìm kiếm trong mỗi thư mục:

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

Filenames (checked in each folder above, in order):
  Doconut.lic                          — base viewer license (checked first)
  Doconut.Viewer.lic                   — base viewer license
  Doconut.Viewer.<Capability>.lic      — per-plugin license, alongside the base license

Không có gì bên ngoài thư mục wwwroot được đọc: một .lic trong thư mục đầu ra, hoặc trong wwwroot/lib, sẽ bị bỏ qua.

Sao chép giấy phép vào thư mục đầu ra của bạn

Khi tiến trình không chạy từ thư mục dự án — một ứng dụng đã xuất bản, IIS, một container, một trình chạy thử — lần dò đầu tiên sẽ bỏ lỡ, và lần thứ hai, {AppContext.BaseDirectory}/wwwroot, phải tìm tệp. Ứng dụng thử nghiệm của SDK tự sao chép các giấy phép vào đó trong mỗi lần biên dịch bằng mục tiêu MSBuild này:

<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- Xóa trước, vì vậy việc đổi tên hoặc xóa một .lic trong wwwroot cũng sẽ loại bỏ nó khỏi đầu ra. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

Đích đến phải là $(OutDir)wwwroot: một .lic được sao chép vào gốc đầu ra sẽ không bao giờ được tự động tìm kiếm phát hiện. Các ví dụ LicensePath trên trang này chỉ tới cùng một vị trí.

Giữ các tệp .lic ra khỏi hệ thống kiểm soát nguồn — triển khai chúng cùng với ứng dụng, hoặc tiêm giấy phép thông qua LicenseContent hoặc LicenseStream từ 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. AddDoconut() thành công, ứng dụng 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ệ, can thiệp, đưa vào danh sách đen, hoặc bản dựng nằm ngoài cửa sổ phiên bản của giấy phép gây ra OpenDocumentAsync ném LicenseException kèm với License.RejectionMessage. Một giấy phép hết hạn theo lịch mà không có thông báo từ chối sẽ tiếp tục ở chế độ có dấu nước.

Plugin cần các khả năng

Đăng ký một plugin mà không có quyền tương ứng thì khác: đối với giấy phép thiếu, tệp legacy TRIAL, hoặc giấy phép trả phí mà không có khả năng đó, AddDoconut() ném InvalidOperationException, vì vậy ứng dụng không khởi động. Ví dụ, đăng ký plugin Converter mà không có giấy phép cấp 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.

Thông báo cho bạn cách khắc phục trực tiếp: hoặc loại bỏ lời gọi options.AddPlugin<...>() cho plugin đó, hoặc cài đặt giấy phép trả phí hoặc giấy phép Tạm thời/Demo (NFR) đang hoạt động mà cấp khả năng này. Các đăng ký tạm thời được phép tồn tại sau ngày hết hạn để ứng dụng đã cấu hình có thể giảm chức năng ở thời gian chạy thay vì bị sập khi khởi động lại; một khi hết hạn, các khả năng của chúng vẫn bị thu hồi.

Xác minh giấy phép đã tải

Sử dụng IDoconutLicenseService, cùng nguồn dữ liệu đúng mà SDK sử dụng, để 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 trả lại nội dung hoặc khóa của giấy phép.

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
}));

Giấy phép được đọc trong quá trình đăng ký AddDoconut(). ResetLicense hiện là một thuộc tính tương thích mà không có đường tải lại hoạt động, vì vậy việc thay thế tệp giấy phép yêu cầu khởi động lại ứng dụng.

Ma trận khắc phục sự cố

Các bước tiếp theo

• Cấp phép — các khả năng, các cấp giấy phép, và xác minh những gì đã được tải ở thời gian chạy.
• Khắc phục sự cố — dấu nước, giấy phép bị từ chối, và lỗi khả năng.