ライセンス設定

IIS 下で Doconut がライセンスファイルを探す場所

ライセンスがなくても、Doconut はドキュメントをレンダリングします — 各ページには評価用の透かしが表示されます。このページでは、Global.asax でライセンスを提供する4つの方法、ライセンスを提供しない場合に Doconut がどこを探すか、そしてプラグインのライセンスが欠けている場合に何が起こるかを説明します。

ライセンスを提供する4つの方法

DoconutOptions には明示的な3つのソースがあります — ファイルパス、ストリーム、または生のコンテンツ — さらに、いずれも設定されていない場合は自動検出が行われます。すべては一度だけ、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") ?? "";
});

自動検出

3つのうちどれも設定しないと、Doconut は自らライセンスを検索します:

csharp
// 何も設定せず、Doconut がライセンスを自ら検索します。その順序は次のとおりです:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (IIS の場合: サイトのルート フォルダー)
// まず Doconut.lic を探します。存在しない場合は、Doconut.Viewer.lic と任意の
// プラグインごとの Doconut.Viewer.<Capability>.lic ファイル。
Doconut.DoconutHost.Initialize();

順番に検索される2つのフォルダーと対象ファイルは次のとおりです:

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 event log(Application ログ、ソース 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 event log、source ASP.NET;プラグインの .lic が Doconut.Viewer.lic の隣にあるか
LicensePath はローカルでは動作するがサーバーでは動作しないワーカープロセスフォルダーに対して相対パスが解決されているHostingEnvironment.MapPath("~/wwwroot/...") でビルドしてください
置き換えた .lic ファイルに効果がないアプリケーション起動時にライセンスが読み込まれたアプリケーションプールをリサイクルする
OpenDocumentAsync が LicenseException をスローするライセンスは見つかったが拒否された例外メッセージを確認してください;信頼できないクライアントには表示しないでください

次のステップ

このページは役に立ちましたか?