Install Atlassian Companion

Still need help?

The Atlassian Community is here for you.

Ask the community

If your site uses Atlassian Companion method to edit files, you will need to install the Atlassian Companion app before you can start editing. Learn more about Editing Files

The way you install Companion will depend on your operating system, and your organisation's environment. 

Download the latest Companion version

Download the Atlassian Companion app for Mac or Windows.

Windows

These instructions are for Windows 10. The process is similar in earlier, supported Windows versions. 

  1. Download the Companion app from Windows download
  2. Double click to run the Atlassian Companion-1.X.X Setup.exe file you just downloaded.
  3. That's it. You may briefly see a progress indicator like the one below. 
     


Once installed, Companion runs in the background. You may need to click the Show hidden items arrow in the system tray to see it. Right click the Companion icon to see the version you have installed. 

The first time you edit a file, you'll be prompted to trust your Confluence site. Once that's done, Companion is ready to use. 

Mac

These instructions are for MacOS 10. Your version may look slightly different. 

  1. Download the Companion app from Mac download
  2. Double click the Atlassian Companion.dmg file you just downloaded.
  3. The install dialog will appear. Drag the Atlassian Companion icon to the Applications folder icon. 



  4. Launch the companion app:
    1. In Finder, go to your Applications folder, and click Atlassian Companion.app, or
    2. In Launchpad, select Atlassian Companion, or
    3. In Spotlight, search for Atlassian Companion. 

Once launched, Companion runs in the background. Click the Companion icon in the status area of the menu bar to see the version you have installed. 

The first time you edit a file, you'll be prompted to trust your Confluence site. Once that's done, Companion is ready to use. 

Linux

Atlassian Companion is not currently available for Linux. 

Managed or restricted environments

If you're not able to install applications on your computer, your administrator or IT team may need to do this for you. 

Send them a link to Administering the Atlassian Companion App for information about MSI installation. 

Troubleshooting

Companion is installed twice in Windows

It's possible to have two versions of Companion installed simultaneously if you have installed Companion using the installer (.exe) and the MSI (.msi).  If this happens, you should uninstall both versions from Add/Remove programs and then re-install Companion (either using the .exe or the .msi depending on how you want to be able to update Companion in future).  

Remove residual files after uninstalling Companion in Windows

If you need to completley uninstall Companion you may want to check if any residual files remain. 
 

Where does Companion save files in Windows?

The default installation directories are:

  • EXE: %LOCALAPPDATA%/atlassian-desktop-companion
  • MSI: Program Files (x86)/Atlassian Companion

The app stores temporary data and edited files in:

  • %APPDATA%/Atlassian Companion
  • C:\Users\<UserName>\.atlassian-companion

Companion creates the following registry entries:

  • Computer\HKEY_CLASSES_ROOT\atlassian-companion
  • Computer\HKEY_CURRENT_USER\Software\Classes\atlassian-companion
  • Computer\HKEY_CURRENT_USER\Software\Microsoft\atlassian-desktop-companion

You can do a registry search for "atlassian" to locate them. These are used for both the MSI and EXE.

Last modified on Apr 22, 2020

Was this helpful?

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