diff --git a/README.md b/README.md index 65349e2..5ae7183 100755 --- a/README.md +++ b/README.md @@ -2,4 +2,8 @@ Sync backup snapshots to a different device using rclone -Note: Drive password must be obscured using `rclone obscure mysecretpass` \ No newline at end of file +## Usage + +Add this URL as a registry in your Home Assistant Supervisor tab: https://github.com/ViViDboarder/hassio-addon-rclone + +Note: Drive password must be obscured using `rclone obscure mysecretpass` diff --git a/rclone/DOCS.md b/rclone/DOCS.md index 83b4b0a..32cabf7 100755 --- a/rclone/DOCS.md +++ b/rclone/DOCS.md @@ -1,15 +1,48 @@ -# rclone +# Rclone Snapshot Sync + +[Rclone](https://rclone.org) is an open-source tool for syncing data between a wide range of remote tarets. + +This addon allows you to sync backup snapshots to a different device using rclone + +## Configuring a drive + +Before you can set up your destionation, you'll need to configure a "drive" in rsync. This can be done by embedding values in the `destination` field in your config (eg. `destination: ":ftp,host=,user=,pass=:/path/on/server"`, or via the web UI accessible once the plugin is running. + +### An important note on passwords... +Rclone expects passwords to be obscured. When you provide your password in either method (inline in destination or through the web UI), you must provide an obscured password. + +To obscure your password, you'll need to [install `rclone`](https://rclone.org/install/) on one of your computers and then follow [the instructions in the rclone documentation](https://rclone.org/commands/rclone_obscure/) ## Configuration -|field|description| -|---|---| -|`cron`|Cron schedule to run the sync job| -|`destination`|The rclone destination in the form `:`| -|`sync_command`|Rclone command to execute (`sync`, `copy`, or `move`)| -|`credentials.username`|Username to view web UI| -|`credentials.password`|Password to view web UI| -|`tls.ssl`|Enable TLS. Recommended if not using ingress| -|`tls.certfile`|TLS cert file to use| -|`tls.keyfile`|TLS key file to use| +### Option: `cron` +Cron schedule to run the sync job. Need help? https://crontab.guru/ + +### Option: `destination` + +The rclone destination in the form `:`. See note above on how to set up a drive. + +### Option: `sync_command` + +Rclone command to execute (`sync`, `copy`, or `move`) + +### Option: `credentials.username` + +Username to view web UI + +### Option: `credentials.password` + +Password to view web UI + +### Option: `tls.ssl` + +Enable TLS. Recommended if not using ingress + +### Option: `tls.certfile` + +TLS cert file to use when ssl is enabled + +### Option: `tls.keyfile` + +TLS key file to use when ssl is enabled diff --git a/rclone/README.md b/rclone/README.md index 65349e2..0025b65 100755 --- a/rclone/README.md +++ b/rclone/README.md @@ -1,5 +1,7 @@ -# Rclone addon +# Rclone Snapshot Sync -Sync backup snapshots to a different device using rclone +## About -Note: Drive password must be obscured using `rclone obscure mysecretpass` \ No newline at end of file +[Rclone](https://rclone.org) is an open-source tool for syncing data between a wide range of remote tarets. + +This addon allows you to sync backup snapshots to a different device using rclone