Skip to content

Commit 821fb5f

Browse files
committed
images and text fixes
1 parent 7969bd8 commit 821fb5f

9 files changed

Lines changed: 18 additions & 11 deletions

File tree

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,28 @@
22

33
Control and monitor your recurring [Rclone](https://rclone.org) jobs from [Home Assistant dashboards](https://www.home-assistant.io/dashboards/).
44

5-
[screenshot]
5+
![Screenshot of the History Dashboard](/docs/media/History_Dashboard.png) ![Screenshot of the Sensor Entities](/docs/media/Sensors.png)
66

77
## Features
88

9-
- Control and Monitor Rclone jobs running on another device, via the [rc](https://rclone.org/rc/) API
9+
- Control and monitor Rclone jobs running on another device, via the [rc](https://rclone.org/rc/) API
1010
- Start/Stop a job from a Home Assistant "switch" device
1111
- Customizable sensors to monitor job stats and health
1212
- Easily build custom automations and dashboards
1313
- Fully local by default – no cloud access required
1414

15-
This is intended for a particular use case: you have one or more rclone commands that you want to run on a recurring schedule (for example, to [bisync](https://rclone.org/bisync/) a [local machine](https://rclone.org/local/) with an [rclone remote](https://rclone.org/overview/)), and you want to monitor the health and progress of those jobs from beautiful Home Assistant dashboards. Perhaps you also want to leverage Home Assistant's powerful [automation](https://www.home-assistant.io/docs/automation/) and [notification](https://www.home-assistant.io/integrations/notify/) features (say, to alert you if something fails, or trigger an rclone job from some other event.)
15+
This is intended for a particular use case: you have one or more rclone commands that you want to run on a recurring schedule (for example, to [bisync](https://rclone.org/bisync/) a [local machine](https://rclone.org/local/) with an [rclone remote](https://rclone.org/overview/)), and you want to monitor the health and progress of those jobs from beautiful Home Assistant dashboards. Perhaps you also want to leverage Home Assistant's powerful [automation](https://www.home-assistant.io/docs/automation/) and [notification](https://www.home-assistant.io/integrations/notify/) features (say, to alert you if something fails, trigger an rclone job from some other event, or skip a run when a prior command is running.)
1616

17-
The rclone jobs you monitor do not necessarily need to be running on the same machine as Home Assistant. For example, Home Assistant could simultaneously monitor rclone jobs running on multiple different LAN-connected computers.
17+
The rclone jobs you monitor do not need to be running on the same machine as Home Assistant. For example, Home Assistant can monitor rclone jobs running on multiple different LAN-connected computers. It can also run concurrent async jobs on the same machine, while managing the concurrency efficiently and tracking stats separately.
1818

19-
[more screenshots]
19+
![Screenshot of the Device page](/docs/media/Device.png) ![Screenshot of a job history dashboard](/docs/media/Jobs_Timeline.png)
20+
21+
<details>
22+
<summary>More screenshots</summary>
23+
24+
![Screenshot of the Config Entities page](/docs/media/Config_Entities.png) ![Screenshot of the config options form](/docs/media/Config.png)
25+
![Screenshot of the Switch entity](/docs/media/Switch.png) ![Screenshot of a Transfers graph](/docs/media/Transfers_Graph.png)
26+
</details>
2027

2128
## Quick Start
2229

@@ -59,14 +66,14 @@ rclone rcd -vv --rc-addr=localhost:5572 --rc-user=SOME_USERNAME --rc-pass=SOME_P
5966
Rclone defaults to `http://localhost:5572` unless a different [`--rc-addr`](https://rclone.org/commands/rclone_rcd/#server-options) is specified. This is fine if you are running Home Assistant and Rclone on the same device. If you are running them on different local devices connected to the same LAN, you can use a local IP address like `--rc-addr=192.168.XX.XX:5572` (depending on your router settings). The port can be customized as needed.
6067

6168
> [!WARNING]
62-
> Using a public IP address is also possible, but make sure you understand the security implications first. Consider using something like [tailscale](https://tailscale.com/docs/how-to/quickstart) to mitigate risks. See also HA's docs on [remote access](https://www.home-assistant.io/docs/configuration/remote/).
69+
> Using a public IP address is also possible, but make sure you understand the security implications. Consider using something like [tailscale](https://tailscale.com/docs/how-to/quickstart) to mitigate risks. See also HA's docs on [remote access](https://www.home-assistant.io/docs/configuration/remote/). Only `http` is supported at this time. [`https`](https://tailscale.com/docs/how-to/set-up-https-certificates) could conceivably be supported in a future version.
6370
64-
Because rclone needs to be running continuously in order for Home Assistant to reach it, consider setting up a cron job to periodically run `rclone rcd`, to ensure rclone remains accessible in the event of fatal errors or machine restarts.
71+
Because rclone needs to be running in order for Home Assistant to reach it, consider setting up a cron job to periodically run `rclone rcd`, to ensure rclone remains accessible in the event of fatal errors or machine restarts.
6572
6673
For example, the following cron job:
6774
6875
```sh
69-
*/5 * * * * rclone rcd -vv --rc-addr=localhost:5572 --rc-user=SOME_USERNAME --rc-pass=SOME_PASSWORD --rc-job-expire-duration=1h
76+
*/5 * * * * rclone rcd -vv --rc-addr=localhost:5572 --rc-user=SOME_USERNAME --rc-pass=SOME_PASSWORD --rc-job-expire-duration=1h
7077
```
7178
7279
will attempt to run the [`rclone rcd`](https://rclone.org/commands/rclone_rcd/) command every 5 minutes. If a prior rclone instance is already running on that [`--rc-addr`](https://rclone.org/commands/rclone_rcd/#server-options), the newer instance will simply exit with `address already in use`.
@@ -91,14 +98,14 @@ will attempt to run the [`rclone rcd`](https://rclone.org/commands/rclone_rcd/)
9198
1. Locate your Home Assistant [`config/custom_components`](https://www.home-assistant.io/docs/configuration/#to-find-the-configuration-directory) directory. It may need to be created.
9299

93100
> [!TIP]
94-
> There are numerous options to access this directory, including the [file editor app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-file-editor-app), the [Samba app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-samba-app), and the [SSH app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-ssh-app).
101+
> There are numerous options to access this directory, including the [file editor app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-file-editor-app), [Samba app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-samba-app), and [SSH app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-ssh-app).
95102

96103
> [!TIP]
97104
> If the [Samba app](https://www.home-assistant.io/common-tasks/os/#installing-and-using-the-samba-app) is enabled, rclone itself can be used to copy files to it, using the [SMB backend](https://rclone.org/smb/).
98105

99106
2. Copy the `custom_components/rclone` directory into your Home Assistant `config/custom_components` directory, including the `rclone` folder itself.
100107

101-
The following example shows how to do this using rclone itself, assuming you have set up an [`smb`](https://rclone.org/smb/) remote named `homeassistant:`
108+
The following example shows how to do this using rclone, assuming you have set up an [`smb`](https://rclone.org/smb/) remote named `homeassistant:`
102109

103110
```sh
104111
# download repo zip from github
@@ -183,7 +190,7 @@ The easiest way to set these up is through the visual editor (Settings > Automat
183190
184191
### 5. (Optional) Set up a Dashboard
185192
186-
While it's easy enough to monitor entities from the default "device" page, you may want to set up a "Dashboard" to emphasize the jobs and metrics that are most important to you, and customize how they are displayed. Designing dashboards is a huge topic beyond the scope of this tutorial, but for convenience, an [example template](/examples/dashboards/rclone_dashboard.yaml) is provided. You will need to replace the entities with your own.
193+
While it's easy enough to monitor entities from the default "device" page, you may want to set up a "Dashboard" to emphasize the jobs and metrics that are most important to you, and customize how they are displayed. Designing dashboards is a huge topic and beyond the scope of this tutorial, but for convenience, an [example template](/examples/dashboards/rclone_dashboard.yaml) is provided. You will need to replace the entities with your own.
187194

188195
### 6. Editing your Configuration
189196

docs/media/Config.png

66 KB
Loading

docs/media/Config_Entities.png

119 KB
Loading

docs/media/Device.png

107 KB
Loading

docs/media/History_Dashboard.png

121 KB
Loading

docs/media/Jobs_Timeline.png

115 KB
Loading

docs/media/Sensors.png

161 KB
Loading

docs/media/Switch.png

50.2 KB
Loading

docs/media/Transfers_Graph.png

81.7 KB
Loading

0 commit comments

Comments
 (0)