许可证设置

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 > 自动搜索。
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 以及任何
// 每个插件的 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 —— 没有错误页面、没有堆栈跟踪、IIS 日志中也没有任何记录。异常仅记录在 Windows 事件日志(Application log,source ASP.NET)中。如果在添加 AddPlugin 行后整个站点立即停止响应,请在代码之前检查 wwwroot 中的许可证文件:插件的 Doconut.Viewer.<Capability>.lic 必须与 Doconut.Viewer.lic 并列放置,且没有基础许可证时插件文件根本不会被读取。

验证已加载的许可证

IDoconutLicenseService 是 SDK 使用的相同可信来源。从 DoconutHost.Services 解析它以公开经过身份验证的诊断端点或驱动功能标志 —— 永不返回许可证内容:

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 中读取一次。替换许可证文件后,回收应用程序池(或触碰 Web.config),以便 Application_Start 再次运行。

故障排除

症状可能原因检查
查看器工作正常,但每个页面都有水印未找到许可证.lic 是否位于 <site root>\wwwroot?请调用上面的状态端点
在添加插件后,每个请求都会返回空的 500已注册的插件没有获得许可证授权Windows 事件日志,来源 ASP.NET;插件的 .lic 与 Doconut.Viewer.lic 并列
LicensePath 在你的机器上可用,但在服务器上不可用相对路径相对于工作进程文件夹解析使用 HostingEnvironment.MapPath("~/wwwroot/...") 构建
替换的 .lic 文件没有效果许可证在应用启动时已读取回收应用程序池
OpenDocumentAsync 抛出 LicenseException许可证已找到但被拒绝读取异常信息;不要向不受信任的客户端显示

下一步

  • 许可 — 功能,以及如何在运行时检查它们。
  • 故障排除 — 水印、启动失败以及其他症状。

此页面对您有帮助吗?