Atlassian Companion アプリの管理
このページは Confluence Server と Data Center に当てはまります。
2022 年 3 月末に、Companion アプリは Confluence Cloud から削除されます。アナウンスを読む
Confluence Data Center および Server における Companion アプリのサポートを終了する予定はありません。
The Atlassian Companion app enables users to edit Confluence files in their preferred desktop application, then save the file back to Confluence automatically.
The download and re-upload of files is managed by the Atlassian Companion app, which needs to be installed on each user's machine (not in the Confluence installation directory) to enable file editing.
On this page:
Download and install the Atlassian Companion app
To edit files, users need to install the Atlassian Companion app and have it running in the background. The first time a user clicks the Edit button in file preview, we prompt them to download and install the app. See Edit Files for details.
ユーザーが自身でアプリケーションをインストールできない場合、管理者はアプリを配信するか、Microsoft Installer を使用してデプロイすることができます。
シングル サインオンの考慮事項
If you've configured single sign-on (SSO) in such a way that your reverse proxy redirects the requests to your SSO gateway, and only successfully authenticated requests ever reach Confluence, your users won't be able to edit files using the Atlassian Companion app. This is because the Atlassian Companion app uses JWT tokens to authenticate requests, and only Confluence can authenticate these requests, not your SSO authenticator.
To make sure requests from the Atlassian Companion app can be authenticated, you should configure your reverse proxy to always allow requests from the following URLs:
<base-url>/rest/token-auth/api/*<base-url>/download/token-auth/attachments/*<base-url>/plugins/servlet/imgFilter*<base-url>/rest/analytics/1.0/publish/bulk(データの収集にオプトインしている場合にのみ必要)
未認証のユーザーがこれらの URL に直接アクセスしようとすると、Confluence のログイン画面にリダイレクトされます。これらのユーザーは未認証の間は、コンテンツやダウンロード ファイルにアクセスすることはできません。
Confluence がコンパニオンを提供するダウンロード URLtoken-auth にパス不一致既知の問題があります。CONFSERVER-63189-課題情報を取得中...ステータス
コンテンツ セキュリティ ポリシー (CSP) に関する考慮事項
厳しいコンテンツ セキュリティ ポリシーが適用されている場合、ブラウザによって Companion の起動が拒否され、ブラウザのコンソールにコンテンツ セキュリティ ポリシー エラーが表示されます。このエラーが発生するのは、Confluence 7.3 以上では Companion のカスタム プロトコル (atlassian-companion) を起動するために非表示の iframe を使用するためです。この問題を解決するには、default-src または frame-src リストに atlassian-companion: を追加する必要があります。以下に例を示します。
frame-src atlassian-companion:;コンテンツ セキュリティ ポリシーは、最も一般的には、リバース プロキシで設定されます。
Microsoft Installer (MSI) から Companion アプリをインストールする
We also provide a Microsoft Installer package (.msi file) to deploy the Atlassian Companion app for Windows across multiple users or machines. By default, the Companion app installs to the Program Files directory, but you can customize this.
Download the Atlassian Companion MSI (69 MB)
上記のリンクで MSI ではなく .exe ファイルがダウンロードされた場合、次の URL をブラウザにコピーしてファイルをダウンロードします。
https://update-nucleus.atlassian.com/Atlassian-Companion/291cb34fe2296e5fb82b83a04704c9b4/latest/win32/ia32/Atlassian%20Companion.msiMicrosoft インストーラーを使用して、特定のコンピューター上のすべてのユーザー用の Companion アプリをインストールします。
msiexec /i “Atlassian Companion.msi” COMPANION_TRUSTED_DOMAINS=“https://confluence.atlassian.com;https://support.atlassian.com/ja;” /qb ALLUSERS=“1"Microsoft Installer を使用してデプロイする場合、Companion アプリは最新のアップデート (セキュリティやバグ修正など) を自動的に取得しません。そのため、メンテナンスが必要になります。
We may update the Companion app before or after we release a new version of Confluence. Check the Atlassian Companion app release notes to make sure you're on the latest version.
標準インストール スイッチ
Microsoft インストーラーは、標準のインストール スイッチをサポートしています。たとえば、TARGETDIR APPLICATIONROOTDIRECTORY およびパラメーターを指定してインストールし、インストール ディレクトリを変更します。
msiexec /i "Atlassian Companion.msi" TARGETDIR="C:\Users\Emma\AppData\Local\Companion" APPLICATIONROOTDIRECTORY="C:\Users\Emma\AppData\Local\Companion" /qb
信頼済みドメインを設定する
Companion 1.2.0 以降では、Confluence の URL を信頼済みのドメインとして設定すると、ユーザーはファイルを最初に編集するときに [このドメインを信頼する] を選択する必要がなくなります。
システム管理者は、Companion アプリをすべてのユーザーにロール アウトする前に、2 つの方法を用いて信頼済みドメイン / サイトを設定できます。いずれの方法でも、各ユーザーのコンピューターに COMPANION_TRUSTED_DOMAINS と呼ばれる環境変数が設定されるか、COMPANION_TRUSTED_DOMAINS パラメーターが Microsoft Installer (MSI) に渡されます。複数の信頼済みドメインを設定するには、セミコロン (;) を区切り文字として使用します。
MSI を使用したインストールで信頼済みのドメインを設定する
msiexec /i "Atlassian Companion-1.1.0.msi" COMPANION_TRUSTED_DOMAINS=“https://confluence.atlassian.com;https://support.atlassian.com/ja;"仮想デスクトップ環境との互換性
From Confluence 7.3 onwards, Atlassian Companion app should work in most session-based virtual desktops.
編集したファイルの復元
ユーザーがファイルを編集すると、そのファイルはダウンロードされてコンピューターの Atlassian Companion フォルダーに保存されます。60 日よりも前に変更されたファイルは、Companion アプリの再起動時に自動的にクリアされます。
Follow our guide to accessing Confluence files edited with the Atlassian Companion app.
Cache フォルダの削除方法
ディスク容量を解放したい場合、Cache フォルダを手動で削除できます。Cache フォルダのファイルを個別に削除するとエラーが発生することがあるため、Cache フォルダ全体を削除する必要があります。Companion アプリの実行中に Cache フォルダがロックされている場合は、Companion を終了し、Cache フォルダを削除してから Companion を開きます。
ファイル編集の無効化
Confluence 7.3 以降では、ファイル編集を完全に無効にすることはできません。ただし、以前の Office での編集機能に戻せば、Companion アプリの統合が無効になります。
Alternatives to the Atlassian Companion app
Confluence の特定のバージョンでは、以前の Office での編集機能に戻すことができます。これは、自身の環境で Companison アプリを使用できないお客様向けの回避策です。
> [一般設定] > [Office Connector] に移動します。- [すべてのユーザーに Office での編集を許可] を選択して変更を保存します。
これにより、サイトのすべてのユーザーで Companion アプリ機能が無効化されます。