From 2124a1d2065e136802d2fc6e180ccbeaacd1649f Mon Sep 17 00:00:00 2001 From: Tommy Larsson <45052383+larssont@users.noreply.github.com> Date: Sun, 17 Nov 2019 15:30:05 +0100 Subject: [PATCH] Update ombi.markdown (#11169) * Update ombi.markdown * Edit example entry * Adjust text based on code changes * Alter setup text --- source/_integrations/ombi.markdown | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/source/_integrations/ombi.markdown b/source/_integrations/ombi.markdown index 8f3742b96a0..41d7e9a31fd 100644 --- a/source/_integrations/ombi.markdown +++ b/source/_integrations/ombi.markdown @@ -12,8 +12,12 @@ The `Ombi` integration monitors data from your [Ombi](https://ombi.io) instance. ## Setup +This component needs to authenticate to your Ombi instance with either a user `password` or an `api_key`. + To find your `api_key` open the Ombi web interface. Navigate to **Settings** and then to **Ombi**, you should then be able to see your `api_key`. +If you want to use `password` authentication simply use the same `password` you normally use to login to Ombi. Alternatively, you can set up a separate local account in Ombi designated for Home Assistant. In order to do this, open the Ombi web interface. Navigate to **User Management** and then press **Add User To Ombi**. Input your desired user details and use the same details when configuring this integration. + ## Configuration If you want to enable this sensor, add the following lines to your `configuration.yaml`: @@ -21,16 +25,12 @@ If you want to enable this sensor, add the following lines to your `configuratio ```yaml # Example configuration.yaml entry ombi: - api_key: OMBI_API_KEY host: OMBI_HOST username: OMBI_USERNAME + password: OMBI_PASSWORD ``` {% configuration %} -api_key: - description: Your Ombi API key. - required: true - type: string host: description: The hostname or IP Address Ombi is running on. required: true @@ -39,6 +39,14 @@ username: description: Your Ombi username. required: true type: string +password: + description: Your Ombi password. [`password`](#password) and [`api_key`](#api_key) cannot be specified concurrently. + required: exclusive + type: string +api_key: + description: Your Ombi API key. [`password`](#password) and [`api_key`](#api_key) cannot be specified concurrently. + required: exclusive + type: string port: description: The port Ombi is running on. required: false @@ -60,9 +68,9 @@ ssl: ```yaml # Example configuration.yaml entry ombi: - api_key: OMBI_API_KEY host: OMBI_HOST username: OMBI_USERNAME + api_key: OMBI_API_KEY port: OMBI_PORT urlbase: ombi/ ssl: true