Browse Source

Update documentation

main
ViViDboarder 11 months ago
parent
commit
e1766c6009
  1. 6
      README.md
  2. 55
      rclone/DOCS.md
  3. 8
      rclone/README.md

6
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`
## 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`

55
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=<myhost>,user=<myuser>,pass=<mypass>:/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 `<drive>:<path>`|
|`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 `<drive>:<path>`. 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

8
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`
[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

Loading…
Cancel
Save