You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,21 +2,28 @@
2
2
3
3
Control and monitor your recurring [Rclone](https://rclone.org) jobs from [Home Assistant dashboards](https://www.home-assistant.io/dashboards/).
4
4
5
-
[screenshot]
5
+

6
6
7
7
## Features
8
8
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
10
10
- Start/Stop a job from a Home Assistant "switch" device
11
11
- Customizable sensors to monitor job stats and health
12
12
- Easily build custom automations and dashboards
13
13
- Fully local by default – no cloud access required
14
14
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.)
16
16
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.
18
18
19
-
[more screenshots]
19
+

20
+
21
+
<details>
22
+
<summary>More screenshots</summary>
23
+
24
+

25
+

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.
60
67
61
68
> [!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.
63
70
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.
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/)
91
98
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.
92
99
93
100
> [!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).
95
102
96
103
> [!TIP]
97
104
> 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/).
98
105
99
106
2. Copy the `custom_components/rclone` directory into your Home Assistant `config/custom_components` directory, including the `rclone` folder itself.
100
107
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:`
102
109
103
110
```sh
104
111
# download repo zip from github
@@ -183,7 +190,7 @@ The easiest way to set these up is through the visual editor (Settings > Automat
183
190
184
191
### 5. (Optional) Set up a Dashboard
185
192
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.
0 commit comments