From ff0f41fe5034feae3cf4a2fcc03c521e18ced5e3 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 21:55:34 +0200 Subject: [PATCH] Fix deluge configuration (#6748) * Fix deluge configuration * Fix eg., * Fix required username and password * Add default --- source/_components/sensor.deluge.markdown | 46 +++++++++++++++++------ source/_components/switch.deluge.markdown | 31 +++++++++++---- 2 files changed, 59 insertions(+), 18 deletions(-) diff --git a/source/_components/sensor.deluge.markdown b/source/_components/sensor.deluge.markdown index 948849b0aad..e82d6a264e6 100644 --- a/source/_components/sensor.deluge.markdown +++ b/source/_components/sensor.deluge.markdown @@ -31,14 +31,38 @@ sensor: - 'upload_speed' ``` -Configuration variables: - -- **host** (*Required*): This is the IP address of your Deluge daemon, eg. 192.168.1.32. -- **port** (*Optional*): The port your Deluge daemon uses. Defaults to 58846. Warning, this is not the port of the WebUI. -- **name** (*Optional*): The name to use when displaying this Deluge instance. -- **username** (*Required*): Your Deluge daemon username. -- **password** (*Required*): Your Deluge daemon password. -- **monitored_variables** array (*Required*): Conditions to display in the frontend. - - **current_status**: The status of your Deluge daemon. - - **download_speed**: The current download speed. - - **upload_speed**: The current upload speed. +{% configuration %} +host: + required: true + type: string + description: This is the IP address of your Deluge daemon, e.g., 192.168.1.32. +port: + required: false + type: integer + description: The port your Deluge daemon uses. Warning, this is not the port of the WebUI. + default: 58846 +name: + required: false + type: string + default: Deluge + description: The name to use when displaying this Deluge instance. +username: + required: true + type: string + description: Your Deluge daemon username. +password: + required: true + type: string + description: Your Deluge daemon password. +monitored_variables: + required: true + type: list + description: Conditions to display in the frontend. + keys: + current_status: + description: The status of your Deluge daemon. + download_speed: + description: The current download speed. + upload_speed: + description: The current upload speed. + {% endconfiguration %} diff --git a/source/_components/switch.deluge.markdown b/source/_components/switch.deluge.markdown index b9673415c39..43afb1976f6 100644 --- a/source/_components/switch.deluge.markdown +++ b/source/_components/switch.deluge.markdown @@ -27,10 +27,27 @@ switch: password : PASSWORD ``` -Configuration variables: - -- **host** (*Required*): This is the IP address of your Deluge daemon, eg. 192.168.1.32. -- **username** (*Required*): Your Deluge username, if you use authentication. -- **password** (*Required*): Your Deluge password, if you use authentication. -- **port** (*Optional*): The port your Deluge daemon uses, defaults to 58846. Warning,this is not the port of the WebUI -- **name** (*Optional*): The name to use when displaying this Deluge instance. +{% configuration %} +host: + required: true + type: string + description: This is the IP address of your Deluge daemon, eg., 192.168.1.32. +username: + required: true + type: string + description: Your Deluge username, if you use authentication. +password: + required: true + type: string + description: Your Deluge password, if you use authentication. +port: + required: false + type: integer + default: 58846 + description: "The port your Deluge daemon uses. (Warning: This is not the port of the WebUI.)" +name: + required: false + type: string + default: Deluge Switch + description: The name to use when displaying this Deluge instance. +{% endconfiguration %}