Administering the Atlassian Companion App

 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.

If your users aren't able to install applications themselves, you may want to distribute the app to them or deploy using the Microsoft Installer.

Download the latest Companion version

Download the Atlassian Companion app for Mac or Windows.

Single sign-on considerations

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     (only necessary if you have opted in to data collection)

If an unauthenticated user tries to access these URLs directly, they would be redirected to the Confluence login screen. The wouldn't be able to access any content or download files while unauthenticated.

Content security policy (CSP) considerations

If you have a restrictive content security policy, your browser will refuse to launch companion, and you'll see a content security policy error in the browser console. This error occurs because Confluence 7.3 and later uses a hidden iframe to attempt to launch Companion's custom protocol (atlassian-companion).  To resolve this problem you will need to add atlassian-companion: to the default-src or frame-src  list. For example:

frame-src atlassian-companion:;

The content security policy is most commonly configured in your reverse proxy.

Install the Companion app via Microsoft Installer (MSI)

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)

If the link above downloads an .exe file instead of the MSI, copy the URL below into your browser to download the file.

https://update-nucleus.atlassian.com/Atlassian-Companion/291cb34fe2296e5fb82b83a04704c9b4/latest/win32/ia32/Atlassian%20Companion.msi

If you deploy using the Microsoft Installer, the Companion app won’t automatically get the latest updates, including security and bug fixes, so some maintenance is required.

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.

Set trusted domains

In Companion 1.2.0 and later, set your Confluence URL as a trusted domain so users don’t have to select 'Trust this domain' when they edit a file for the first time. 

System administrators have two options for setting trusted domains/sites before rolling out the Companion app to all users. Either set an environment variable called COMPANION_TRUSTED_DOMAINS on each user's computer, or pass the parameter COMPANION_TRUSTED_DOMAINS to the Microsoft Installer (MSI). Set multiple trusted domains by using semicolons (;) as separators.

To set trusted domains when installing using the MSI:

msiexec /i "Atlassian Companion-1.1.0.msi" COMPANION_TRUSTED_DOMAINS=“https://confluence.atlassian.com;https://support.atlassian.com;"

Disable file editing

System Administrators can remove the edit files option from their Confluence site.

To disable the edit files option when previewing a file:

  1. Go to  > Manage apps 
  2. From the drop-down menu, select System.
  3. Click Confluence Previews from the displayed list.
  4. Click the enabled modules link.
  5. Hover on the Edit With plugin for the Media Viewer (companion-plugin) module, and click Disable.

To disable the edit option from the Attachments page, Attachments macro and View File macros:

  1. Go to  > Manage apps
  2. From the drop-down menu, select System.
  3. Click Confluence Previews from the displayed list.
  4. Click the enabled modules link.
  5. Hover on the Embedded 'Edit With' button (embedded-edit) module and click Disable.

Compatibility with virtual desktop environments

From Confluence 7.3 onwards, Atlassian Companion app should work in most session-based virtual desktops. 

Recover edited files

When a user edits a file, that file is also downloaded and saved to the Atlassian Companion folder on their computer. Files are cleared every time the Companion app restarts.

Follow our guide to accessing Confluence files edited with the Atlassian Companion app.

How to delete the Cache folder

If you’d like to free up disk space, it’s safe to manually delete the cache folder. Deleting individual files in the cache folder may cause errors, so you should delete the entire Cache folder. If the cache folder is locked while Companion App is running, quit Companion, delete the cache folder, then open Companion.

Where can I find the Cache folder?

For Windows, Companion 1.0.0, go to C:\Users\admin\AppData\Roaming\Atlassian Companion\Cache.

For Windows, Companion 1.1.0, go to C:\Users\admin\AppData\Local\Atlassian Companion\Cache.

For Mac, Companion 1.0.0 and 1.1.0, go to Home/Library/Application Support/Atlassian Companion/Cache.

Alternatives to the Atlassian Companion app

In some versions of Confluence, you can revert to the previous Edit in Office functionality. This is a workaround for customers who are unable to use the Companion app in their environment. 

To enable the legacy Edit in Office functionality:
  1. Go to  > General Configuration > Office Connector.

  2. Choose Enable Edit in Office for all users and save your changes. 

This will disable Companion app functionality for all users in the site. 

Last modified on Aug 12, 2020

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.