Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hkcomori committed Jul 26, 2024
1 parent 9a1ec31 commit 9f3004d
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,37 @@ Available variables are listed below, along with default values (see `defaults/m

This can be used to toggle the installation of manpages.

### `rclone_manpages_location: "{{ default_rclone_manpages_location }}"`

The location to install `rclone` manpages. The default is an OS specific location, but you can override it anywhere.

### `rclone_manpages_owner:`

These variables allow for setting the ownership of manpages for `rclone`. They are mostly needed if configuring `rclone` to run as an other user than root (maybe a specific backup user or so).

rclone_manpages_owner:
OWNER: rclone
GROUP: rclone

### `rclone_binary_location: "/usr/local/bin/"`

The location to install the `rclone` binary.

### `rclone_binary_owner:`

These variables allow for setting the ownership of the `rclone` binary. They are mostly needed if configuring `rclone` to install for non-root user.

rclone_binary_location: "/home/rclone/.local/bin/rclone/rclone"
rclone_binary_owner:
OWNER: rclone
GROUP: rclone

### rclone_fact_path: "/etc/ansible/facts.d/rclone.fact"

The location to ansible local facts for `rclone`. They are mostly needed if you run this role by non-root user.

rclone_fact_path: "/home/rclone/.config/ansible/facts.d/rclone.fact"

### `rclone_arch: "amd64"`

This variable chooses the target architecture (for example 'amd64').
Expand Down Expand Up @@ -177,6 +208,8 @@ Note: This example assumes you have created the `rclone.service` systemd unit yo

This variable allows for the configuration of rclone mounts within your infrastructure. `rclone_mounts` should be a YAML list of objects, each including keys for `name`, `remote_name`, `remote_path`, `local_path`, `auto_mount`, and `extra_args`. This setup enables precise control over multiple mount points, their remote sources, and whether they should be automatically mounted.

If you use this variable, you must run this role as root using `become: true`.

#### Detailed example for `rclone_mounts`

To define mounts, you'll specify each mount's details in the playbook, allowing Ansible to handle the mounting process as per your configuration. This method is advantageous for managing mounts across multiple systems or ensuring persistent mounts across reboots when combined with the `auto_mount` option.
Expand Down

0 comments on commit 9f3004d

Please sign in to comment.