/companion-linux

Unofficial Atlassian Confluence Companion App for Linux

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Confluence Companion App for Linux

This Python script emulates the functionality of the Atlassian Companion App (Windows/Mac) for usage on Linux clients.

With the Companion App you can edit files in Atlassian Confluence with your preferred (local installed) desktop application.

This script is currently in beta. Contributions welcome. Please also tell me if the script just works fine with your confluence installation and linux distribution.

Debian Package Installation (Debian/Ubuntu/Mint)

  1. Download and install the .deb package from the latest release on Github.
  2. After installation please log out and log in again. The script then starts automatically.

Manual Installation (Debian/Ubuntu/Mint)

  1. Install required Python packages
apt install python3-pip python3-distutils python3-pyinotify
pip3 install websockets

  1. Edit companion.py and change ALLOWED_SITE = "Confluence" to your site name. If the defined name does not match the confluence server name, all requests are rejected. If rejected, the script prints out the site name, so you can adjust it.

  2. Set execution rights and start the script.

chmod +x companion.py
./companion.py

Further hints:

  • Temporary files will be saved in ~/.cache/companion/tmp. Please ensure that you have write permissions in that directory.
  • You can put companion.py in your personal autostart.
  • You can copy companion.desktop into /etc/xdg/autostart to install it in autostart for all users. Please do not forget to adjust the script path in the companion.desktop file.

Installation Details

Generating an own Certificate

Update: SSL encryption between Browser and Companion App (through atlassian-domain-for-localhost-connections-only.com) is not supported anymore as described here. Confluence now uses a direct WebSocket connection to 127.0.0.1 (no domain name) without transport encryption.