インストール

Doconut を .NET 6 プロジェクトに追加

.NET 6 用の基本 Doconut ビューアは、任意の ASP.NET Core アプリケーションに組み込める単一の NuGet パッケージとして提供されます。オプションのプラグインは別個のパッケージを使用します。このページでは、基本パッケージをインストールし、ミドルウェアを登録します — 最初のレンダーを行う前に必要な最低限の手順です。

必要条件

プラットフォームサポート
Windows x64 / x86はい
Linux x64, glibc-based (Debian, Ubuntu, the official mcr.microsoft.com/dotnet/aspnet:6.0-bookworm-slim image)はい
Alpine and other musl-based distributionsいいえ
macOSいいえ

Linux では、最初のドキュメントを開く前にフォント設定ライブラリをインストールしてください:

bash
apt-get update && apt-get install -y libfontconfig1

RHEL、Fedora などの類似ディストリビューションでは、パッケージは fontconfig (dnf install -y fontconfig) です。これが Doconut が必要とする唯一のシステムパッケージで、使用するネイティブライブラリは NuGet パッケージ内に同梱されており、libgdiplus は不要です。

Docker では aspnet:6.0-bookworm-slim (Debian 12) を推奨します。デフォルトの aspnet:6.0 タグは Debian 11 で、パッケージミラーが libfontconfig1 のインストールに失敗することがあります。ページはサーバーにインストールされたフォントで描画されるため、フォントや Linux のエラーメッセージについては トラブルシューティング を参照してください。

パッケージのインストール

bash
dotnet add package Doconut.NET6

バージョン指定なしのコマンドは最新の安定版リリースをインストールします。このドキュメントで説明しているリリースを固定したい場合は、バージョンを別オプションとして渡してください:

bash
dotnet add package Doconut.NET6 --version 26.10.0

Doconut.NET6 はパッケージ ID です。バージョンサフィックスはダウンロードされた Doconut.NET6.<version>.nupkg ファイル名に付属しており、ID の一部ではありません。

アップグレード前に統合を特定する

Doconut.NET6 パッケージ ID は、従来の統合と現在の .NET 6 統合の両方で使用されています。パッケージ名だけでドキュメントを選択しないでください:

  • DocImage.axd, new Viewer(_cache, _accessor, ...), 同期 OpenDocument(...), および手動でコピーされたビューアスクリプトは 従来の統合 を識別します;
  • AddDoconut(), UseDoconutResources(), 注入された Viewer, および OpenDocumentAsync(...) は、ここで文書化されている現在の統合を識別します。

翻訳された 従来のセットアップマニュアル は引き続き利用可能です。世代を変更するには 移行ガイド を使用してください。通常のパッケージ更新では、スタートアップ、ビューアのライフタイム、またはブラウザリソースは自動的に変換されません。

Doconut の登録

AddDoconut() は唯一の登録エントリポイントです — オーバーロードは一つだけで、Viewer サービス、ライセンスサービス、レンダリングインフラストラクチャを DI コンテナに接続します。

2 つのミドルウェア呼び出しでセットアップが完了し、順序が重要です: UseDoconutResources() は UseDoconut() の前に実行する必要があります。 UseDoconut() はターミナルミドルウェアで、最初に呼び出すと /doconut-res アセットへのすべてのリクエストがリソースハンドラに届かず 404 になります。UseDoconut() は届いたリクエストすべてに応答するため、app.Map と共に単独のブランチにマウントしてください。セッションの配線も必要です — Doconut のデフォルトドキュメントセキュリティは、すべてのページリクエストを ASP.NET セッション状態と照合します。

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // セッション状態にはキャッシュが必要です(MVC/Razor Pages はすでに追加されています)
builder.Services.AddSession(); // Doconut のドキュメントセキュリティは ASP.NET のセッション状態に依存しています

app.UseSession();          // UseDoconut() の前に UseSession() を呼び出してください
app.UseDoconutResources(); // UseDoconut() の前に登録する必要があります
app.Map("/doconut", branch => branch.UseDoconut());

すべてのオプション

DoconutOptions は以下の設定可能なプロパティを受け入れます。すべて任意で、プロパティが未設定の場合は以下のデフォルトが適用されます。

プロパティデフォルト説明
ShowDoconutInfofalsetrue の場合、token が無いリクエストは 404 の代わりにバージョンバナーを返します。スモークチェックとして便利ですが、本番環境では無効にしてください。
UnsafeModefalsetrue の場合、ページリクエスト時の ASP.NET セッションセキュリティチェックをスキップします。本番環境では無効にしてください。
MiddlewarePath"/doconut"ページイメージエンドポイントの調整値です。検証は行われますが、単独でブランチをマウントすることはありません。実際の UseDoconut() マッピングとクライアント BasePath に合わせてください。
ResourcesPath"/doconut-res"埋め込みの JS/CSS/画像リソースが提供される場所です。
LicensePath"" (empty string)ライセンスファイルへのパスです。空文字列は次のソースへフォールスルーし、その後自動検索されます。
LicenseContent"" (empty string)生のライセンス内容 — 環境変数、シークレットマネージャ、またはデータベースから取得します。
LicenseStreamnullストリームとしてのライセンスで、起動時に一度読み取ります。
ResetLicensefalse予約された互換性フラグです。現在の .NET 6 サービスは AddDoconut() 時にライセンスを読み取ります。ライセンスを置き換えた後はアプリを再起動してください。
MaxConcurrentEditorSessions200ライブエディタセッション(DocOptions.EditMode で開かれたドキュメント)の最大数です。これを超えると、最も使用されていないアイドルエディタセッションが閉じられます。通常のビューアセッションはカウントされません。0 または負の値は上限なしを意味します。
EditorSnapshotEveryOps50エディタ永続化が有効な場合(AddDoconutEditorPersistence)、記録された変更ごとに N 回ごとにライブドキュメントのスナップショットを取ります。0 または負の値はセッション中にスナップショットを取らないことを意味します。永続化が無効な場合は影響しません。

複数のソースが設定されている場合のライセンス優先順位は、LicenseStream が LicenseContent より優先され、LicensePath がそれに続き、最後に自動検索が適用されます — 詳細は ライセンス設定 を参照してください。

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // アプリのマッピングとクライアントの BasePath を調整してください
    options.ResourcesPath   = "/doconut-res"; // ビューアの JS/CSS/画像 が提供される場所
    options.UnsafeMode      = false;          // セッションのセキュリティを有効に保ちます
    options.ShowDoconutInfo = false;
});

次のステップ

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