ライセンス設定

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

ライセンスがなくても、Doconut はドキュメントをレンダリングします — 各ページには評価用の透かしが表示されます。このページでは、ライセンスを提供する4つの方法と、複数設定された場合の正確な優先順位について説明します。

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

4つあります:DoconutOptions 上の3つの明示的なソース(ストリーム、 生のコンテンツ、またはファイルパス)と、いずれも設定されていない場合の自動検出です。複数が設定された場合、優先順位は次の通りです:

優先順位は次の通りです: LicenseStream、次に LicenseContent、次に LicensePath、最後に auto-search。

パスで指定

LicensePath は File.Exists にそのまま渡されます。相対パスはプロセスの current working directory(現在の作業ディレクトリ)に対して解決されます — プロジェクトフォルダーでも、Program.cs が存在するフォルダーでもありません。パスが解決できない場合、Doconut は例外を投げず、auto-search にフォールバックもしません — 単にライセンスを読み込まず、ビューアに透かしが表示されます。auto-search は LicensePath、LicenseContent、または LicenseStream のいずれも設定されていないときにのみ実行されます。同じフォルダー内のプラグインごとのライセンスファイル(Doconut.Viewer.<Capability>.lic)もそれと共に読み込まれるため、LicensePath と AddPlugin<...>() はベースライセンスの隣にプラグインライセンスがある場合に連携して動作します。

絶対パスを使用することを推奨します(例: IWebHostEnvironment.WebRootPath や AppContext.BaseDirectory から構築)。あるいは LicensePath を完全に省略し、以下の自動検出に任せます。

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

ストリームで指定

LicenseStream は起動時に一度だけ読み取られます — ライセンスがディスク上のファイルではなくシークレットストアから取得される場合に便利です。

csharp
// 優先順位: LicenseStream > LicenseContent > LicensePath > 自動検索。
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

コンテンツで指定

LicenseContent はライセンステキストそのものを受け取ります — 環境変数、データベース、またはシークレットマネージャーから取得できます:

csharp
// データベース、環境変数、またはシークレットマネージャーからの License XML —
// ディスク上にファイルがありません。LicenseStream のみが上回ります。
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

自動検出

csharp
// 何も設定せず、Doconut はライセンスを自ら検索します。対象は以下の 2 つのフォルダーのみです:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (ビルド出力フォルダー内の wwwroot)
// まず Doconut.lic を探します;それがない場合は Doconut.Viewer.lic と任意の
// プラグインごとの Doconut.Viewer.<Capability>.lic ファイル。
builder.Services.AddDoconut();

検索対象となるフォルダー(順序)と探すファイル名は次のとおりです:

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

wwwroot フォルダー外のものは読み込まれません:出力フォルダー自体や wwwroot/lib にある .lic は無視されます。

ライセンスを出力フォルダーにコピーする

プロセスがプロジェクトフォルダーから実行されない場合(公開アプリ、IIS、コンテナ、テストランナーなど) 、最初の検索が失敗し、2番目の検索である {AppContext.BaseDirectory}/wwwroot がファイルを見つける必要があります。この MSBuild ターゲットは、ビルドのたびにライセンスをそこへコピーします:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- まず削除します。これにより wwwroot 内の .lic を名前変更または削除すると、出力からも除外されます。 -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

コピー先は $(OutDir)wwwroot である必要があります:出力ルートにコピーされた .lic は auto-search では決して見つかりません。このページの LicensePath の例は同じ場所を指しています。

ソース管理から .lic ファイルを除外してください — アプリと同じ場所にデプロイするか、シークレットストアから LicenseContent または LicenseStream を通じてライセンスを注入します。

ライセンスがない場合に何が起こるか

ライセンスが欠如していても例外はスローされません。AddDoconut() は成功し、アプリが起動し、ビューアが実行されます — ただしすべてのページに評価用の透かしが付与され、オプション機能は付与されません。

見つかったが拒否されたライセンス ファイルは別です。無効な署名、改ざん、ブラックリスト登録、またはライセンスのバージョンウィンドウ外のビルドが原因で、OpenDocumentAsync は LicenseException を License.RejectionMessage とともにスローします。期限切れの Temporary ライセンスは透かし付きモードで継続します。サブスクリプション日が過ぎた有料ライセンスは、期限前にリリースされたすべてのビルドで、機能がそのまま利用でき、クリーンに動作し続けます。

プラグインには機能が必要です

対応する権利が付与されていないプラグインを登録する場合は異なります:ライセンスが欠如している場合、レガシー TRIAL ファイルがある場合、またはその機能が付与されていない有料ライセンスの場合、AddDoconut() は InvalidOperationException をスローし、アプリは起動しません。例えば、Converter を付与するライセンスなしで Converter プラグインを登録した場合:

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.

メッセージは直接修正方法を示します:そのプラグインに対する options.AddPlugin<...>() 呼び出しを削除するか、機能を付与する有料ライセンスまたは有効な Temporary/Demo (NFR) ライセンスをインストールしてください。Temporary 登録は有効期限が過ぎても存続できるため、既に構成されたアプリは再起動時にクラッシュする代わりに実行時に機能低下します;期限が切れると、機能は引き続き取り消されます。

読み込まれたライセンスを検証する

IDoconutLicenseService を使用します。これは SDK が使用する同じ真実の情報源で、認証済み診断エンドポイントを公開したり、機能フラグを制御したりします。ライセンスの内容やキーを返さないでください。

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

ライセンスは AddDoconut() 登録時に読み取られます。ResetLicense は現在、アクティブなリロードパスを持たない互換性プロパティであるため、ライセンス ファイルを置き換えるにはアプリケーションの再起動が必要です。

トラブルシューティングマトリックス

症状考えられる原因確認項目
ビューアは動作するがすべてのページに透かしが付くライセンスがロードされていない、または Temporary ライセンスが期限切れIDoconutLicenseService を解決し、出力ディレクトリとプロセスの作業ディレクトリを確認してください
AddDoconut() がプラグインでスローされるライセンスがそのプラグインの機能を付与していないIsCapabilityGranted(...) を確認し、購入していない登録を削除してください
構成された相対パスはローカルでは機能するが IIS/コンテナでは機能しないプロセスの作業ディレクトリが変更されたAppContext.BaseDirectory または絶対パスを使用してください
置き換えた .lic ファイルに効果がないシングルトン ライセンス サービスがすでに作成されていたアプリケーションを再起動してください
OpenDocumentAsync が LicenseException をスローする署名、ドメイン、バージョンウィンドウ、ブラックリスト、またはプラグイン実行時ゲートがライセンスを拒否した例外/拒否メッセージを読み取り、信頼できないクライアントに公開しないでください

次のステップ

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