Jira

Atlassianマーケットプレイスからコネクタを追加する

1. Jira Softwareインスタンスに管理者としてログインします。
2. 管理アイコンを右上隅でクリックし、メニューからアプリの管理オプションを選択します。
   
3. 新しいアプリを探すセクションが開きます。マーケットプレイスを検索フィールドをクリックし、Jira ONLYOFFICE統合アプリを見つけます。
4. インストールボタンをクリックしてアプリケーションをダウンロードしてインストールします。

ソースコードからコンパイルしたコネクタを追加する

まず、Jira用ONLYOFFICEコネクタをコンパイルするために必要な以下の前提条件をインストールする必要があります：

• Oracle Java SE Development Kit 8の1.8.X
• Atlassian Plugin SDK

Jira用ONLYOFFICEコネクタをコンパイルするには、次の手順に従います：

1. onlyoffice-jiraリポジトリをクローンします。

   git clone https://github.com/ONLYOFFICE/onlyoffice-jira.git

2. onlyoffice-jiraディレクトリに移動します。

   cd onlyoffice-jira

3. 次のコマンドを実行します：

   atlas-package

   コネクタがコンパイルされるまで待ちます。その後、コネクタはtargetフォルダにあります。

コンパイルされたコネクタをJira Software管理 > アプリの管理ページにアップロードできます。

1. Jira Softwareインスタンスに管理者としてログインします。
2. 管理アイコンを右上隅でクリックし、メニューからアプリの管理オプションを選択します。
3. ページの左側にあるアプリの管理セクションを選択します。
4. アプリをアップロードリンクをクリックします。
5. ファイルを選択ボタンをクリックし、コンパイルされたtarget/onlyoffice-jira-app.jarファイルを参照してアップロードをクリックします。アプリケーションがインストールされるまで待ちます。
   

Jira用ONLYOFFICEコネクタの設定

Jira ONLYOFFICE統合アプリをアプリの管理ページでインストールした後、設定ボタンをクリックするか、アプリの管理ページのその他セクションでアプリを見つけます。

Document Server

1. 文書編集サービスのアドレスフィールドに、ONLYOFFICE DocsがインストールされているサーバーのIPアドレスまたはホスト名を指定します。
   ONLYOFFICE DocsのアドレスはJiraからアクセス可能である必要があり、JiraのアドレスもONLYOFFICE Docsからアクセス可能である必要があります。
2. 証明書検証を無効にする（安全でない） - このボックスをチェックして証明書検証を無効にし、JiraがONLYOFFICE Docsとの接続を確立できるようにします。自己署名証明書を使用している場合は、Jiraが自己署名証明書を検証せず、ONLYOFFICE Docsとの接続を許可しません。これは安全でない解決策であり、CAによって発行された証明書に置き換えることを強くお勧めします。
3. シークレットキーを指定します（無効にするには空白のままにします） - ONLYOFFICE Docsへのリクエスト時にJSON Webトークンを検証するためのシークレット。
   ONLYOFFICE Docs v7.2以降、JWTはデフォルトで有効になっており、シークレットキーは自動的に生成されます。Jira側でも有効にする必要があります：ONLYOFFICE Docs設定ファイルでシークレットキーを見つけ、コネクタ設定で同じシークレットキーを指定します。詳細については、この記事のONLYOFFICEとJiraの統合のためのJWTの有効化セクションをご覧ください。
4. 認証ヘッダー（デフォルトヘッダーを使用する場合は空白のままにします） - ONLYOFFICEで使用される認証JWTヘッダーはAuthorizationです。このヘッダーがセットアップと競合する場合、カスタムヘッダーに変更することができます。
5. デモONLYOFFICE Document Serverに接続 - テストサーバーを起動します。
   重要これは30日間利用可能な公開テストサーバーです。そこに機密データを共有しないでください。

高度なサーバー設定

高度なサーバー設定セクションは、インストールされたJira SoftwareとONLYOFFICE Docs間のリクエストがパブリックアドレスを使用して許可されていない場合に使用できます。この場合、内部リクエスト用のアドレスを対応するフィールドに指定します：

1. 文書編集サービスからの内部リクエスト用サーバーアドレス - ONLYOFFICE Docsからの内部リクエスト用Jira Softwareサーバーアドレス
2. サーバーからの内部リクエスト用文書編集サービスアドレス - Jira Softwareサーバーからの内部リクエスト用ONLYOFFICE Docsアドレス

共通設定

1. 編集可能なフォーマット - Jira環境でサポートされているフォーマットの横にあるチェックボックスをマークします。

   フォーマットの制限により、指定されたフォーマットで保存する際にデータ損失が発生する可能性があります。

2. エディターインターフェース - エディターのインターフェースをカスタマイズします：
   • チャットメニューボタンを表示 - 左側のパネルにオンライン内蔵チャットアイコンを表示/非表示にします。
   • ヘッダーをよりコンパクトに表示 - 上部ツールバーのアイコンテキストを表示/非表示にします。
   • フィードバック＆サポートメニューボタンを表示 - 左側のパネルにフィードバック＆サポートボタンを表示/非表示にします。
   • ヘルプメニューボタンを表示 - 左側のパネルにヘルプボタンを表示/非表示にします。
   • モノクロームツールバーヘッダーを表示 - 上部ツールバーをモノクロームカラーパレットに切り替えます。

セキュリティ

1. プラグインを有効にする - エディターのプラグインサポートを有効/無効にします。
2. 文書マクロを実行 - エディター内でのマクロの実行を有効/無効にします。
3. 文書保護を有効にする - すべてのユーザーが文書のパスワード保護を有効にすることを許可するか、文書の所有者のみにするかを選択します。

保存をクリックして設定を保存します。

動作の仕組み

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

1. ユーザーがJiraの添付ファイルに移動し、ONLYOFFICEで編集アクションを選択します。
2. JiraがOnlyOfficeEditorServlet（形式のURL：/plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id）にリクエストを送信します。
3. Jiraが文書をONLYOFFICE Documentストレージサービスに送信し、一時リンクを受け取ります。
4. Jiraが次のプロパティを持つJSONオブジェクトを準備します：
   • url: ONLYOFFICE Docsが文書をダウンロードするために使用する一時リンク；
   • callbackUrl: ONLYOFFICE Docsが文書編集のステータスを通知するために使用するURL；
   • docserviceApiUrl: クライアントがONLYOFFICE Docsに返信するために必要なURL（files.docservice.url.apiプロパティによって提供されます）；
   • key: ONLYOFFICE Docsが文書を再ダウンロードするかどうかを指示するUUID；
   • title: 文書のタイトル（名前）。
5. Jiraがこのオブジェクトを使用して、クライアントブラウザがエディターを読み込むために必要な値を埋め込んだfreemarkerテンプレートからページを構築します。
6. クライアントブラウザがONLYOFFICE DocsからJavaScriptライブラリにリクエストを行い、上記のプロパティを持つDocEditor設定をONLYOFFICE Docsに送信します。
7. その後、ONLYOFFICE Docsが文書ストレージから文書をダウンロードし、ユーザーが編集を開始します。
8. すべてのユーザーとクライアントブラウザが編集を終了すると、編集ウィンドウを閉じます。
9. 10秒の非アクティブ状態の後、ONLYOFFICE DocsがcallbackUrlにPOSTを送信し、クライアントが文書の編集を終了し、閉じたことをJiraに通知します。
10. すべての変更が加えられた文書が、ファイル名に接尾辞が追加された新しい添付ファイルとして保存されます。

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

文書を不正アクセスから保護するために、ONLYOFFICEエディターはJSON Webトークン（JWT）を使用します。トークンは、Document Editorが初期化されるときや、内部の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. 変更を加えた場合は、それを保存し、設定変更を反映させるためにサービスを再起動します。

   supervisorctl restart all

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

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

デモONLYOFFICE Docsへの接続

ONLYOFFICEコネクタバージョン2.0.0以降、Jira内でONLYOFFICE DocsをインストールせずにONLYOFFICEオンラインエディターを試すことができます。

接続をオンにするには、デモONLYOFFICE Docsサーバーに接続チェックボックスをクリックし、保存ボタンをクリックします。