インストール

Doconut を .NET 8 プロジェクトに追加する

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

必要条件

パッケージは以下のプラットフォームで動作します:

プラットフォームサポート
Windows x64 / x86はい
Linux x64、glibc ベース (Debian、Ubuntu、公式 mcr.microsoft.com/dotnet/aspnet:8.0 イメージ)はい
Alpine およびその他の musl ベースディストリビューションいいえ
macOSいいえ

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

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

RHEL、Fedora および類似ディストリビューションでは、パッケージは fontconfig (dnf install -y fontconfig) です。これは Doconut が必要とする唯一のシステムパッケージで、使用するネイティブライブラリは NuGet パッケージ内に同梱されており、libgdiplus は不要です。ページはサーバーにインストールされたフォントで描画されるため、フォントや Linux のエラーメッセージについては トラブルシューティング を参照してください。

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

bash
dotnet add package Doconut.NET8

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

bash
dotnet add package Doconut.NET8 --version 26.10.0

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

Doconut の登録

AddDoconut() は唯一の登録エントリポイントです — オーバーロードは 1 つだけで、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();          // UseSession() を UseDoconut() の前に呼び出してください
app.UseDoconutResources(); // UseDoconut() の前に登録する必要があります
app.Map("/doconut", branch => branch.UseDoconut());

すべてのオプション

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

PropertyDefaultDescription
ShowDoconutInfofalsetrue の場合、token がないリクエストは 404 の代わりにバージョンバナーを返します。スモークチェックとして便利です;本番環境では無効にしてください。
UnsafeModefalsetrue の場合、ページリクエスト時の ASP.NET セッションセキュリティチェックをスキップします。本番環境では無効にしてください。
MiddlewarePath"/doconut"ページ画像エンドポイントの調整値です。検証は行われますが、単独でブランチをマウントしません;実際の UseDoconut() マッピングとクライアント BasePath と合わせてください。
ResourcesPath"/doconut-res"埋め込みの JS/CSS/画像リソースが提供される場所です。
LicensePath"" (empty string)ライセンスファイルへのパスです。空の場合は次のソースへフォールスルーし、その後自動検索が行われます。
LicenseContent"" (empty string)生のライセンス内容 — 環境変数、シークレットマネージャ、またはデータベースから取得します。
LicenseStreamnullストリームとしてのライセンスで、起動時に一度だけ読み取ります。
ResetLicensefalse予約された互換性フラグです。現在の .NET 8 サービスは 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;
});

次のステップ

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