jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix radarr configuration (#6753)

Browse Source
This commit is contained in:
cgtobi 2018-10-13 21:41:00 +02:00 committed by Fabian Affolter
parent efc99cedfe
commit e74d12ff57
1 changed files with 55 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
source/_components/sensor.radarr.markdown
View File

@ -26,22 +26,61 @@ sensor:
api_key: YOUR_API_KEY
```
Configuration variables:
- **api_key** (*Required*): Your Radarr API key, found in Settings > General in the Radarr Web UI.
- **host** (*Optional*): The host Radarr is running on. Defaults to `localhost`.
- **port** (*Optional*): The port Radarr is running on. Defaults to 7878.
- **urlbase** (*Optional*): The base URL Radarr is running under. Defaults to `/`.
- **monitored_conditions** array (*Optional*): Conditions to display on the frontend. Defaults to `movies`.
- **movies**: The number of movies in Radarr.
- **upcoming**: The number of upcoming movie releases (physical and in cinemas).
- **commands**: The number of commands being run.
- **diskspace**: The available disk space.
- **status**: The current system status information.
- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1.
- **include_paths** (*Optional*): Array of file paths to include when calculating diskspace. Leave blank to include all.
- **unit**: (*Optional*): The unit to display disk space in. Defaults to GB.
- **ssl**: boolean (*Optional*): Whether or not to use SSL for Radarr.
{% configuration %}
api_key:
required: true
type: string
description: Your Radarr API key, found in Settings > General in the Radarr Web UI.
host:
required: false
type: string
description: The host Radarr is running on.
default: "`localhost`"
port:
required: false
type: integer
description: The port Radarr is running on.
default: 7878
urlbase:
required: false
type: string
description: The base URL Radarr is running under. Defaults to `/`.
monitored_conditions:
required: false
type: list
description: Conditions to display on the frontend.
default: "`movies`"
keys:
movies:
description: The number of movies in Radarr.
upcoming:
description: The number of upcoming movie releases (physical and in cinemas).
commands:
description: The number of commands being run.
diskspace:
description: The available disk space.
status:
description: The current system status information.
days:
required: false
type: integer
description: How many days to look ahead for the upcoming sensor, 1 means today only.
default: 1
include_paths:
required: false
type: list
description: Array of file paths to include when calculating diskspace. Leave blank to include all.
unit:
required: false
type: string
description: The unit to display disk space in.
default: GB
ssl:
required: false
type: boolean
description: Whether or not to use SSL for Radarr.
default: false
{% endconfiguration %}
## {% linkable_title Examples %}