From 044b7ed94dfdf08c94644ee33f116d2727521611 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20GRANDIN?= Date: Sat, 23 Apr 2022 02:45:46 +0200 Subject: [PATCH] :memo: Add Synology Download widget documentation --- docs/widgets.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/widgets.md b/docs/widgets.md index bbfff1d8..85d74ef9 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -46,6 +46,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Pi Hole Queries](#pi-hole-queries) - [Recent Traffic](#recent-traffic) - [Stat Ping Statuses](#stat-ping-statuses) + - [Synology Download Station](#stat-ping-statuses) - **[System Resource Monitoring](#system-resource-monitoring)** - [CPU Usage Current](#current-cpu-usage) - [CPU Usage Per Core](#cpu-usage-per-core) @@ -1325,6 +1326,41 @@ Displays the current and recent uptime of your running services, via a self-host --- +### Synology Download Station + +Displays the current downloads/torrents tasks of your Synology NAS + +

+ +##### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`hostname`** | `string` | Required | The URL to your Synology NAS, without a trailing slash +**`username`** | `string` | Required | The username of a user on your synology NAS. You will see only this user download station tasks if he is not part of the administrator group. Currently don't support OTP protected accounts. +**`password`** | `string` | Required | The password of the account specified above. + +##### Example + +```yaml +- type: synology-download + options: + hostname: http://192.168.1.1:8080 + username: dashy + password: totally-secure-password + + +``` + +##### Info +- **CORS**: 🟠 Proxied +- **Auth**: 🟢 Required +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [Synology](https://www.synology.com/en-us)) +- **Privacy**: _See [Synology Privacy Statement](https://www.synology.com/en-us/company/legal/privacy)_ + +--- + ## System Resource Monitoring The easiest method for displaying system info and resource usage in Dashy is with [Glances](https://nicolargo.github.io/glances/).