MeIchthys f3894f8878
Clarify source of nextcloud entity information (#22393)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2022-04-18 21:44:20 +02:00

2.0 KiB

title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_codeowners, ha_platforms, ha_integration_type
title description ha_category ha_iot_class ha_release ha_domain ha_codeowners ha_platforms ha_integration_type
Nextcloud Instructions on how to integrate Nextcloud monitor api data into Home Assistant.
Binary Sensor
Sensor
Cloud Polling 0.108 nextcloud
@meichthys
binary_sensor
sensor
integration

The nextcloud integration pulls summary Nextcloud information into Home Assistant.

The integration provides sensors and binary sensors for most of the data points that the built-in Nextcloud serverinfo app provides.

To see which datapoints your nextcloud instance exposes, browse to this url: https://<your_nextcloud_url>/ocs/v2.php/apps/serverinfo/api/v1/info?format=json.

Nextcloud Example Sensor

Configuration

This integration has the following Nextcloud Server prerequisites:

  • The user must be in the Nextcloud admin group (Nextcloud > Users)
  • The Nextcloud 'Monitoring' app must be installed (Nextcloud > Apps > 🔍(Search Icon) > Monitoring > Enable)
  • (Recommended) A Nextcloud App password should be generated for use in Home Assistant (Nextcloud > Settings > Personal > Security > Devices & sessions > Create new app password)

To enable the Nextcloud integration, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
nextcloud:
  url: https://YOUR_NEXTCLOUD_URL
  username: YOUR_USERNAME
  password: YOUR_APP_PASSWORD

{% configuration %} url: description: The full URL to your Nextcloud instance. required: true type: string username: description: The username of a Nextcloud user that has access to the Nextcloud monitor API. required: true type: string password: description: The app password generated from the Nextcloud security settings page. required: true type: string {% endconfiguration %}