devpnd/rclone-atlassian repository overview

This script allows to backup Jira and Confluence cloud and uploads the generated files to a Rclone supported storage.

⁠Configuration

The following environment variables are required:

• ATL_HOST: Atlassian host, example.atlassian.net
• ATL_USER_EMAIL: Atlassian user with backup permissions
• ATL_API_TOKEN: Atlassian user token
• ATL_INCLUDE_ATTACHMENTS: true|false, default true
• ATL_FOR_CLOUD: true|false, default false
• REMOTE_PATH: A path on remote storage
• RCLONE_CONFIG_REMOTE_*: rclone config via environment variables for remote:. See https://rclone.org/docs/#environment-variables⁠.
• RCLONE_CONFIG_*: rclone params. See https://rclone.org/docs/#environment-variables⁠.
• BACKUP_PASSWORD: If defined, the remote backup will be ecnrypted with rclone crypt and defined password
• BACKUP_REMOVE_LOCAL: Remove local files after sync. true|false, default false

⁠Example

docker compose for Backblaze B2 and both jira and confluence:

services:
  rclone-atlassian:
    image: devpnd/rclone-atlassian:v1.0
    command: ['jira', 'confluence']

    environment:
      ATL_HOST: ${ATL_HOST}
      ATL_USER_EMAIL: ${ATL_USER_EMAIL}
      ATL_API_TOKEN: ${ATL_API_TOKEN}
      ATL_INCLUDE_ATTACHMENTS: true
      ATL_FOR_CLOUD: false
      RCLONE_CONFIG_REMOTE_TYPE: b2
      RCLONE_CONFIG_REMOTE_ACCOUNT: 0000000000000000000000000
      RCLONE_CONFIG_REMOTE_KEY: DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD
      REMOTE_PATH: backet/mypath
      # Disable check destination for write only mode
      RCLONE_NO_CHECK_DEST: true
      RCLONE_MULTI_THREAD_STREAMS: 1
      # Encrypt remote backup
      BACKUP_PASSWORD: ${BACKUP_PASSWORD}

⁠Changelog

v1.1

– Added BACKUP_REMOVE_LOCAL flag support