Skip to content

Commit

Permalink
docs: document rclone_mkdir
Browse files Browse the repository at this point in the history
  • Loading branch information
tigattack authored and stefangweichinger committed Nov 15, 2024
1 parent f7cc58a commit 8f2c00c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,9 @@ 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`.
The role will attempt to create all defined `remote_path`'s by default. You can disable this by setting `rclone_mkdir` to `false`.

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

#### Detailed example for `rclone_mounts`

Expand Down

0 comments on commit 8f2c00c

Please sign in to comment.