Collabora編集セッションのアイドルタイムアウトを設定する方法

Collabora Onlineには「アイドルタイムアウト」のような設定がいくつかありますが、それぞれ異なる動作を制御します。ユーザーが作業中にエディターが暗くなったり、更新が停止したりする場合は、ビューごとの非アクティブ設定を調整してください。全員が退出した後もドキュメントが読み込まれたままの場合は、ドキュメントごとのタイムアウトを調整してください。エディターが実際に切断された場合は、Collaboraのアイドルポリシーを変更する前に、リバースプロキシのWebSocketタイムアウトを確認してください。

現在の Collabora Online 構成テンプレートでは、ビューごとのアイドルタイムアウトが 15 分、ブラウザタブがフォーカスされていない場合のタイムアウトが 5 分、アイドル状態のドキュメントがアンロードされるまでのタイムアウトが 1 時間となっています。これらのデフォルト値はリリースやパッケージによって異なる場合があるため、変更を加える前に、インストール済みのバージョンに同梱されている構成を確認してください。以下の値は、このガイドで確認した現在のテンプレートの値であり、すべての CODE またはエンタープライズ展開で保証されるものではありません。

希望する動作に基づいて設定を選択してください

Collabora は、現在の coolwsd 設定テンプレートと設定リファレンスで、その意味とデフォルト値を文書化しています。ビューごとのアイドルタイムアウトは、アカウントを閉じたりアクセス権を取り消したりするのとは異なります。ビューを暗くして更新を停止するものです。ドキュメントごとのタイムアウトは、アイドル状態のドキュメントプロセスをアンロードするものであり、編集中のユーザーを強制終了させるタイマーではありません。

おすすめの出発地点

• ユーザーがアクティブなタブがすぐに暗くならないようにするには、デフォルトの設定値から、1,800秒（30分）などの測定可能な間隔に増やしてくださいper_view.idle_timeout_secs。これはあくまでも実用的な出発点であり、普遍的な推奨事項ではありません。
• ユーザーがドキュメントを最新の状態に保ちながらタブを切り替えられるようにするには、個別に値を上げてください。per_view.out_of_focus_timeout_secsフォーカスされているタブでユーザーが操作していないという理由だけで値を上げないでください。
• ドキュメントが放棄された後のメモリ使用量を削減します。ビューごとの値はそのままにして、per_document.idle_timeout_secsドキュメントが実際にアイドル状態であり、ストレージの保存が正常であることを確認した後、値を下げることを検討してください。
• 一定時間内に切断された場合は、プロキシ、イングレス、またはロードバランサーのWebSocketタイムアウトを調べてください。ビューごとの調光設定を変更しても、プロキシによって閉じられたWebSocketは修復されません。
• 頻繁なセーブを維持する：特別な理由がない限り、アイドルセーブと自動セーブの値は現在の設定のままにしておいてください。

coolwsd.xmlの設定を変更してください。

coolwsd.xmlパッケージベースのインストールの場合、実行中のサービスが使用するアクティブファイルを見つけてください。一般的な場所は です/etc/coolwsd/coolwsd.xmlが、パスはディストリビューションや古いリリースによって異なります。サンプルファイルや未使用のマウント済みコピーを編集しても、実行中のサービスが変更されるとは限りません。

アクティブなファイルをバックアップしてから、既存のセクション<per_view>と<per_document>セクションの該当する値のみを編集します。たとえば、次の抜粋では、非アクティブユーザーのタイムアウトを30分、バックグラウンドタブのタイムアウトを15分、アイドル状態のドキュメントのアンロードを2時間に設定しています。

<per_view>
    <idle_timeout_secs>1800</idle_timeout_secs>
    <out_of_focus_timeout_secs>900</out_of_focus_timeout_secs>
</per_view>
<per_document>
    <idle_timeout_secs>7200</idle_timeout_secs>
</per_document>

これは抜粋であり、完全な置き換え設定ではありません。お使いのバージョンに同梱されているファイル内の属性、コメント、ネスト構造、その他の要素はそのまま保持してください。ビルドによっては、追加のXML属性が必要になる場合があります。タブがフォーカスされている間だけ画面の暗さを変更したい場合は、ビューごとのアイドル値のみを編集してください。ビューごとの値とドキュメントのアンロード値を同時に上げると、どの設定が問題解決に役立ったのかが分かりにくくなります。

デプロイメントでサポートされている構成ツールを使用して XML を検証し、そのパッケージに記載されている方法を使用して Collabora を再起動または再読み込みしてください。起動ログで構成解析エラーを確認し、実行中のプロセスが意図したファイルをロードしたことを確認してください。アクティブなプロセスに存在しない設定変更は効果がありません。

DockerまたはKubernetesで同じオプションを設定します

CollaboraのDockerイメージでは、管理者は通常、オプション構文をextra_params使用して設定オプションを渡します--o:。以下のComposeスタイルの値は、同じ例を示しています。

extra_params=--o:per_view.idle_timeout_secs=1800 --o:per_view.out_of_focus_timeout_secs=900 --o:per_document.idle_timeout_secs=7200

イメージとデプロイメントチャートが対応している場合にのみ、これを使用してくださいextra_params。Kubernetes、Helm、またはオペレーター管理のインストールの場合、生成されたコンテナ ファイルを編集するのではなく、チャートまたはカスタム リソースのサポート構成フィールドにオプションを入力してください。Compose で環境変数を変更する場合は、新しい値がコンテナに反映されるようにサービスを再作成または再デプロイしてください。単純な再起動では、既存のコンテナ構成が再利用される可能性があります。

マウントされた XML ファイルと環境パラメータなど、競合する場所に同じオプションを設定しないでください。その場合は、該当リリースの優先順位ルールを確認してください。再デプロイ後は、コンテナの起動ログとアクティブな構成を確認してください。オプション名やコンテナの動作が異なる場合は、Collabora プロジェクトのソースリポジトリと、バージョンに対応したデプロイドキュメントを参照してください。

リバースプロキシのタイムアウトを個別に確認してください

Collaboraのエディタは、ブラウザとの継続的な通信にWebSocketを使用します。プロキシは、Collaboraのドキュメントおよびビューのタイムアウトがかなり長く設定されている場合でも、有効なWebSocket接続を閉じることがあります。その場合、単にビューが暗くなるのではなく、切断、再接続のプロンプト、または更新を受信しなくなるエディタが表示される可能性があります。

プロキシの読み取り/送信タイムアウト、イングレスまたはクラウドロードバランサーのアイドルタイムアウト、およびCollaboraが想定するセッション動作を比較してください。タイムアウトはルート全体で互換性がある必要があります。Collaboraのプロキシ設定ガイドには、WebSocketプロキシの設定と長時間接続の例が含まれています。ご使用のプロキシとリリースに合ったガイダンスを適用してください。古いNginxブロックを別のプロキシや無関係なルートに安易にコピーしないでください。

役立つ手がかりは、障害発生のパターンです。ユーザーが非アクティブビューが暗くなるのしか確認できない場合は、ログを確認してくださいper_view。すべてのユーザーがほぼ同じ経過時間で切断する場合は、そのタイムスタンプのプロキシとロードバランサーのログを確認してください。すべての参加者が退出した後にのみドキュメントが閉じる場合は、ドキュメントごとのタイムアウトがより重要になります。

タイムアウトを一度に1つずつテストします

1. アクティブな設定から現在の値を記録し、Collaboraのバージョンとデプロイ方法をメモしてください。
2. アクティブなビューと非アクティブなビューの両方を観察できるように、2人のユーザーまたは2つのブラウザセッションでテストドキュメントを開いてください。
3. 症状に一致するタイムアウトのみを変更してください。たとえば、フォーカスされているが何も操作されていないタブで画面が暗くなるのを防ぐには、次の設定per_view.idle_timeout_secsのみを調整してください。
4. サポートされている方法で再起動または再デプロイを行い、新しい値がアクティブな構成または起動ログに表示されていることを確認してください。
5. 前のしきい値を超えて待機します。画面がまだ暗くなるか、2番目のユーザーが引き続き更新を受信するか、編集内容が引き続き保存されるかを確認します。
6. テストドキュメントのすべてのビューを閉じ、アイドル状態のドキュメントが意図した範囲内でアンロードされるかどうかを確認してください。
7. Collaboraとプロキシのログを確認し、WebSocketの切断、XML解析エラー、保存失敗、または予期しないプロセスクリーンアップがないか確認してください。

保存されていない本番環境のドキュメントで変更をテストしないでください。アイドル状態のドキュメント処理をアンロードする前に、変更されたファイルがストレージバックエンドに保存されていることを確認してください。問題が保存されていない変更でのみ発生する場合は、タイムアウト時間を毎回延長するのではなく、自動保存とストレージのエラーを別の問題として確認してください。

利便性、資源利用、信頼性のバランスを取る

ビューごとのタイムアウトを長く設定すると、休憩時間にドキュメントを確認したり、複数のブラウザタブで作業したりするチームに適しています。タイムアウトを短く設定すると、非アクティブなビューの更新が早く停止するため、バックグラウンド処理が軽減される可能性がありますが、ドキュメントを閲覧中のユーザーの作業を中断してしまう恐れがあります。ドキュメントごとのタイムアウトは、リソース管理上の別の選択肢です。タイムアウトを長く設定すると、使用されていないドキュメントの読み込み時間が長くなりますが、短く設定すると、ユーザーが戻ってきた際にドキュメントを再度読み込む必要が生じる場合があります。

ほとんどのデプロイメントでは、観測された動作に合うように、必要最小限の設定のみを変更してください。保存間隔は維持し、チームごとに適切なビューごとの非アクティブ期間を設定し、バックグラウンドタブのタイムアウトは意図的に設定し、プロキシのWebSocket制限は、ログまたはタイミングが接続レイヤーの問題を示している場合にのみ調整してください。デフォルト設定やサポートされる設定が変更される可能性があるため、アップグレード後はインストール済みバージョンの構成テンプレートを再確認してください。