Ansible role rclone

Install and configure rclone

GitHub	Downloads	Version

Example Playbook

This example is taken from molecule/default/converge.yml and is tested on each push, pull request and release.

---
- name: Converge
  hosts: all
  become: true
  gather_facts: true

  roles:
    - role: "mullholland.rclone"

Role Variables

The default values for the variables are set in defaults/main.yml:

---
# release of rclone to use.
# 'latest'  => always gets the latest version of rclone
# 'custom'  => lets you define a version to install
rclone_release: "latest"

# ATM only linux ist tested/supported by the role
# rclone supports many others
# https://rclone.org/downloads/
rclone_os: "linux"

# which version to install if not "latest"
rclone_version: '1.59.0'

# Download URL for latest/custom rclone
# change if you need custom URLs
rclone_download_url_latest: "https://downloads.rclone.org/rclone-current-{{ rclone_os }}-{{ rclone_arch }}.zip"
rclone_download_url_custom: "https://downloads.rclone.org/v{{ rclone_version }}/rclone-v{{ rclone_version }}-{{ rclone_os }}-{{ rclone_arch }}.zip"

# where to install
rclone_bin_path: "/usr/local/bin"

# where to store configs
# https://rclone.org/docs/#config-config-file
# defaults to `~/.config/rclone/rclone.conf`
# to make it more "portable" the variable `rclone_bin_path`can be used to store the config alongside the binary
# rclone_conf_path: "{{ rclone_bin_path }}"
# in this case the folder will not be created/touched by ansible
rclone_conf_path: "~/.config/rclone"

# https://rclone.org/docs/
rclone_config: []
# rclone_config:
#   - name: "WebDAV"
#     options:
#       - "type = webdav"
#       - "url = https://nextcloud.domain.tld/remote.php/dav/files/username/"
#       - "vendor = nextcloud"
#       - "user = username"
#       - "bearer_token = SuperSecretToken"

Requirements

• pip packages listed in requirements.txt.

Context

This role is a part of many compatible roles. Have a look at the documentation of these roles for further information.

Here is an overview of related roles:

Compatibility

This role has been tested on these container images:

The minimum version of Ansible required is 2.10, tests have been done to:

• The previous version.
• The current version.
• The development version.

If you find issues, please register them in GitHub.

License

MIT.

Author Information

Mullholland