ライセンス設定
Doconut がライセンスファイルを探す場所
ライセンスがなくても、Doconut はドキュメントをレンダリングし続けます — 各ページには評価用の透かしが表示されます。このページでは、ライセンスを提供する4つの方法と、複数設定された場合の正確な優先順位について説明します。
ライセンスを提供する4つの方法
4つあります: DoconutOptions 上の3つの明示的なソース — ストリーム、 生のコンテンツ、 またはファイルパス — と、いずれも設定されていない場合の自動検出です。複数が設定されている場合、優先順位は次のとおりです:
LicenseStream > LicenseContent > LicensePath > 自動検索
パスで指定
LicensePath は File.Exists にそのまま渡されます。相対パスはプロセスの 現在の作業ディレクトリ に対して解決されます — プロジェクトフォルダーや、Program.cs が存在するフォルダーではありません。パスが解決できない場合、Doconut は例外を投げず、自動検索 にフォールバック しません — 単にライセンスをロードせず、閲覧ツールに透かしが表示されます。自動検索 は LicensePath、LicenseContent、または LicenseStream のいずれも設定されていないときにのみ実行されます。同じフォルダー内のプラグインごとのライセンスファイル (Doconut.Viewer.<Capability>.lic) もそれと共に読み込まれるため、LicensePath と AddPlugin<...>() はベースライセンスの隣にプラグインライセンスがある場合に連携して動作します。
絶対パスを使用することを推奨します(例: IWebHostEnvironment.WebRootPath や AppContext.BaseDirectory から構築されたもの)。あるいは LicensePath を完全に省略し、以下の自動検出に依存してください。
builder.Services.AddDoconut(options =>
{
options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});ストリームで指定
LicenseStream は起動時に一度だけ読み取られます — ライセンスがディスク上のファイルではなくシークレットストアから取得される場合に便利です。
// 優先順位: LicenseStream > LicenseContent > LicensePath > 自動検索。
builder.Services.AddDoconut(options =>
{
options.LicenseStream = licenseStream;
});コンテンツで指定
LicenseContent はライセンス本文そのものを受け取ります — 環境変数、データベース、またはシークレットマネージャーから取得できます:
// データベース、環境変数、またはシークレットマネージャーからの License XML —
// ディスク上にファイルがありません。LicenseStream にのみ負けます。
builder.Services.AddDoconut(options =>
{
options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});自動検出
3つの明示的なソースのいずれも設定しないと、Doconut が自らライセンスを検索します:
// 何も設定せず、Doconut はライセンス自体を検索します。対象は以下の 2 つのフォルダーのみです:
// 1. {CurrentDirectory}/wwwroot
// 2. {AppContext.BaseDirectory}/wwwroot (ビルド出力フォルダー内の wwwroot)
// まず Doconut.lic を探します。見つからない場合は Doconut.Viewer.lic と任意の
// プラグインごとの Doconut.Viewer.<Capability>.lic ファイル。
builder.Services.AddDoconut();検索対象フォルダーは順番に以下で、探すファイル名は次の通りです:
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 foundwwwroot フォルダー外のものは読み取られません: 出力フォルダー自体や wwwroot/lib にある .lic は無視されます。
ライセンスを出力フォルダーにコピーする
プロセスがプロジェクトフォルダーから実行されない場合(公開アプリ、IIS、コンテナ、テストランナーなど) 、最初の検索が失敗し、2番目の検索である {AppContext.BaseDirectory}/wwwroot がファイルを見つける必要があります。この MSBuild ターゲットは、ビルドのたびにライセンスをそこにコピーします:
<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 は 自動検索 では決して見つかりません。このページの LicensePath の例は同じ場所を指しています。
ソース管理から
.licファイルを除外してください — アプリと同じ場所にデプロイするか、シークレットストアからLicenseContentまたはLicenseStreamを通じてライセンスを注入してください。
ライセンスがない場合に何が起こる
ライセンスが欠如している場合、例外はスローされません。AddDoconut() が成功し、アプリが起動し、ビューアが実行されますが、すべてのページに評価用の透かしが付与され、オプション機能は付与されません。
ライセンスファイルが見つかったが拒否された場合は異なります。無効な署名、改ざん、ブラックリスト、またはライセンスのバージョンウィンドウ外のビルドが原因で、OpenDocumentAsync が LicenseException を License.RejectionMessage とともにスローします。期限切れの Temporary ライセンスは透かし付きモードで継続します。サブスクリプション日が過ぎた有料ライセンスは、期限前にリリースされたすべてのビルドで、クリーンに機能し、機能が有効なまま動作し続けます。
プラグインには機能が必要です
対応する権利がないプラグインを登録すると、状況は異なります。ライセンスが欠如している場合、レガシー TRIAL ファイルがある場合、またはその機能を持たない有料ライセンスの場合、AddDoconut() が InvalidOperationException をスローし、アプリは起動しません。例えば、Converter を付与するライセンスなしで 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.メッセージは直接修正方法を示します:そのプラグインの options.AddPlugin<...>() 呼び出しを削除するか、機能を付与する有料ライセンスまたは有効な Temporary/Demo (NFR) ライセンスをインストールしてください。Temporary 登録は有効期限が過ぎても存続できるように許可されているため、既に構成されたアプリは再起動時にクラッシュする代わりに実行時に機能を低下させます。期限が切れると、機能は依然として取り消されます。
読み込まれたライセンスを検証する
SDK が使用する同じ真実の情報源である IDoconutLicenseService を使用し、認証された診断エンドポイントを公開したり、機能フラグを制御したりします。ライセンスの内容やキーを返さないでください。
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 をスローする | 署名、ドメイン、バージョンウィンドウ、ブラックリスト、またはプラグイン実行時ゲートがライセンスを拒否しました | 例外/拒否メッセージを読み取りますが、信頼できないクライアントに公開しないでください |
次のステップ
- ライセンス — 機能、ライセンス階層、そして実行時にロードされたものの検証。
- トラブルシューティング — 透かし、拒否されたライセンス、機能エラー。
このページは役に立ちましたか?