Liferay

要件

• ONLYOFFICE Document Server v6.1.0（サーバーまたはクラウドバージョン）以降。

  Liferayおよびエンドクライアントから解決可能で接続可能なONLYOFFICE Docsのインスタンスが必要です。Liferayに直接POSTできる必要があります。

  ONLYOFFICE Docsのインストールについて詳しくは、公式のドキュメントページをご覧ください。
• Liferay CE Portal 7.2 GA1+、Liferay DXP 7.2 GA1+、Liferay CE Portal 7.3 GA1+、Liferay DXP 7.3 GA1+、Liferay CE Portal 7.4 GA1+、Liferay CE 7.4 GA44 - GA73、Liferay DXP 7.4 U44 - U73。
• Liferay用ONLYOFFICE Connector v2.2.0。

Liferay用ONLYOFFICE Connectorのインストール

App Managerを使用してONLYOFFICEコネクタをインストールできます。

App Managerを使用してインストールするには：

1. コントロールパネル > システム > App Managerに移動します。
2. オプションボタンをクリックします。
3. アップロードボタンをクリックします。
4. 開いたウィンドウでONLYOFFICEアプリケーションファイルを選択します。

インストールが完了すると、アプリケーションは使用可能になります。

コネクタを自分でビルドする場合は、コンパイルされた.jarファイルをbuild\libsフォルダーから/opt/liferay/deployに配置するだけです。Liferayが自動的にインストールします。

Liferay用ONLYOFFICE Connectorのコンパイル

gradle buildを実行するだけです。出力された.jarはbuild/libsディレクトリ内に配置されます。

Liferay用ONLYOFFICEコネクタの設定

コントロールパネル > 設定 > システム設定に移動します。プラットフォームセクションでコネクタカテゴリを選択し、ONLYOFFICEを選択します。

ここで次の設定を構成できます：

• ONLYOFFICE Docsアドレス - ドキュメント編集サービスがインストールされているURLアドレスを指定します。
  ONLYOFFICE DocsのアドレスはLiferayからアクセス可能である必要があり、LiferayのアドレスもONLYOFFICE Docsからアクセス可能である必要があります。
• サーバーからの内部リクエスト用ONLYOFFICE Docsアドレス - Liferayからドキュメント編集サービスにアクセスするために使用されるアドレスを指定します。
• ONLYOFFICE Docsからの内部リクエスト用サーバーアドレス - ドキュメント編集サービスからLiferayにアクセスするために使用されるアドレスを指定します。
• シークレットキー - データを署名するために使用されるシークレットを指定します。
  ONLYOFFICE Docs v7.2以降、JWTはデフォルトで有効になっており、シークレットキーは自動的に生成されます。Liferay側でも有効にする必要があります：ONLYOFFICE Docs設定ファイルでシークレットキーを見つけ、コネクタ設定で同じシークレットキーを指定します。詳細については、この記事のONLYOFFICEとLiferayの統合のためのJWTの有効化セクションを参照してください。
• 認証ヘッダー（デフォルトのヘッダーを使用するには空白のままにします） - ONLYOFFICEで使用される認証JWTヘッダーはAuthorizationです。このヘッダーが設定と競合する場合は、カスタムヘッダーに変更できます。
• 強制保存を有効にする - 編集中に中間ドキュメントバージョンを保持するためにチェックボックスをアクティブにします。
• ONLYOFFICE Webプレビューを有効にする - ファイルプレビューを有効にするためにチェックボックスをアクティブにします。

統合アプリケーションの設定が完了したら、保存ボタンをクリックして変更を適用します。

動作の仕組み

ONLYOFFICEの統合は、こちらに記載されているAPIに従います。

1. ユーザーはLiferay内のドキュメントとメディアセクションに移動し、ONLYOFFICEで編集アクションを選択します。
2. Liferayは次のプロパティを持つDocument Server用のJSONオブジェクトを準備します：
   • url: ONLYOFFICE Docsが文書をダウンロードするために使用するURL；
   • callbackUrl: ONLYOFFICE Docsが文書編集のステータスを通知するために使用するURL；
   • key: fileVersionIdを使用してONLYOFFICE Docsが文書を再ダウンロードするかどうかを指示；
   • title: 文書のタイトル（名前）。
3. クライアントブラウザはONLYOFFICE DocsからJavaScriptライブラリへのリクエストを行い、上記のプロパティを持つDocEditor設定をONLYOFFICE Docsに送信します。
4. その後、ONLYOFFICE DocsはLiferayから文書をダウンロードし、ユーザーは編集を開始します。
5. ONLYOFFICE Docsは、ユーザーが文書を編集していることを通知するためにcallbackUrlにPOSTリクエストを送信します。
6. Liferayは文書をロックしますが、書き込みアクセスを持つ他のユーザーがONLYOFFICE Docsとリアルタイムで共同作業できるようにアクションを残します。
7. すべてのユーザーとクライアントブラウザが編集を終了すると、編集ウィンドウを閉じます。
8. 10秒の非アクティブ状態の後、ONLYOFFICE DocsはcallbackUrlにPOSTを送信し、クライアントが文書の編集を終了し閉じたことをLiferayに知らせます。
9. Liferayは文書の新しいバージョンをダウンロードし、古いものを置き換えます。

ONLYOFFICEとLiferayの統合のためのJWTの有効化

文書を不正アクセスから保護するために、ONLYOFFICEエディターはJSON Web Token（JWT）を使用します。トークンはドキュメントエディターの初期化時と、内部ONLYOFFICE Docsサービス間のコマンド交換時に構成に追加されます。シークレットキーはJSON Webトークンを署名し、ONLYOFFICE Docsへのリクエスト時にトークンを検証するために使用されます。

ONLYOFFICE Docs v7.2以降、JWTはデフォルトで有効になっており、シークレットキーは自動的に生成されます。ONLYOFFICE Docs設定ファイルでシークレットキーを見つけ、コネクタ設定で同じシークレットキーを指定する必要があります。

ステップ1: ONLYOFFICE Docs設定ファイルでシークレットキーを見つける

1. 任意のテキストエディタでlocal.jsonファイルを開きます。
   • Linuxの場合 - /etc/onlyoffice/documentserver/local.json
   • Windowsの場合 - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
   • Dockerの場合 – docker exec -it <containerID> bashコマンドを使用してONLYOFFICE Docsコンテナに入り、/etc/onlyoffice/documentserver/local.jsonを開きます。

     または、local.jsonを開かずにデフォルトのシークレットキーを見つけるために次のコマンドを使用できます：

     sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

   local.jsonファイルは次のようになります：

   {"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}}

2. true値が3つのセクションに指定されています。これはトークン検証が有効であることを意味します。
   • services.CoAuthoring.token.enable.browser
   • services.CoAuthoring.token.enable.request.inbox
   • services.CoAuthoring.token.enable.request.outbox
3. 自動生成されたシークレットキーは3つのセクションに指定されています。デフォルトのシークレット値を独自のシークレットキーに置き換えることができます。シークレットキーは3つのセクションで同じである必要があります。
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. 変更を加えた場合は、それを保存し、設定変更を反映させるためにサービスを再起動します。
   • Linuxの場合：

     sudo supervisorctl restart all

   • Dockerの場合：

     docker exec <containerID> supervisorctl restart all

     または、コンテナ全体を再起動します：

     docker restart <containerID>

ステップ2: コネクタ設定で同じシークレットキーを指定する

コネクタ設定で、シークレットキーフィールドに同じシークレットを指定し、設定を保存します。