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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update ombi.markdown (#11169)

Browse Source 
* Update ombi.markdown

* Edit example entry

* Adjust text based on code changes

* Alter setup text
This commit is contained in:
Tommy Larsson 2019-11-17 15:30:05 +01:00 committed by Franck Nijhof
parent 5139a6519d
commit 2124a1d206
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_integrations/ombi.markdown
View File

@ -12,8 +12,12 @@ The `Ombi` integration monitors data from your [Ombi](https://ombi.io) instance.
## Setup ## 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`. 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 ## Configuration
If you want to enable this sensor, add the following lines to your `configuration.yaml`: 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
ombi: ombi:
api_key: OMBI_API_KEY
host: OMBI_HOST host: OMBI_HOST
username: OMBI_USERNAME username: OMBI_USERNAME
password: OMBI_PASSWORD
``` ```
{% configuration %} {% configuration %}
api_key:
description: Your Ombi API key.
required: true
type: string
host: host:
description: The hostname or IP Address Ombi is running on. description: The hostname or IP Address Ombi is running on.
required: true required: true
@ -39,6 +39,14 @@ username:
description: Your Ombi username. description: Your Ombi username.
required: true required: true
type: string 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: port:
description: The port Ombi is running on. description: The port Ombi is running on.
required: false required: false
@ -60,9 +68,9 @@ ssl:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
ombi: ombi:
api_key: OMBI_API_KEY
host: OMBI_HOST host: OMBI_HOST
username: OMBI_USERNAME username: OMBI_USERNAME
api_key: OMBI_API_KEY
port: OMBI_PORT port: OMBI_PORT
urlbase: ombi/ urlbase: ombi/
ssl: true ssl: true