ライセンス設定

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

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

ライセンスは 一度、AddDoconut() 中に 読み込まれます。これは以前の .NET Standard ライブラリとは異なり、そこではライセンスは Viewer インスタンスに渡すか、静的な Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...) 呼び出しで設定していました。このリリースではそれらのメソッドは起動メカニズムではありません — マイグレーション ガイド を参照してください。

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

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

LicenseStream が LicenseContent を上回り、LicensePath を上回り、auto-search を上回ります。

パスで指定

LicensePath は File.Exists にそのまま渡されます。相対パスはプロセスの 現在の作業ディレクトリ に対して解決されます — プロジェクトフォルダではなく、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
// データベース、環境変数、またはシークレットマネージャーから取得するライセンス XML —
// ディスク上にファイルはありません。LicenseStream にだけ上回られます。
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

自動検出

3つの明示的なソースのいずれも設定しない場合、Doconut は自らライセンスを検索します:

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-capability licenses, read only when Doconut.Viewer.lic was found

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

以前に Viewer コンストラクタにライセンスパスの List<string>(機能ごとに1つ)を渡していた場合、その補助ファイルを Doconut.Viewer.lic の隣に置き、自動検出に取得させてください。DoconutOptions にはパスのリストオプションはありません。

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

プロセスがプロジェクトフォルダーから実行されない場合(公開アプリ、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 は自動検索で決して見つかりません。このページの 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 をスローする署名、ドメイン、バージョンウィンドウ、ブラックリスト、またはプラグイン実行時ゲートがライセンスを拒否した例外/拒否メッセージを読み取り、信頼できないクライアントに公開しないでください
機能別ライセンスは以前は動作したが現在は動作しない旧コードが明示的に Viewer コンストラクタにライセンスパスを渡していた伴随する .lic ファイルを Doconut.Viewer.lic の隣に移動し、自動検出に任せてください

次のステップ

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