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

Add sensors and admin disclaimer to paperless docs (#39213)

Browse Source
This commit is contained in:
Florian von Garrel 2025-05-26 17:24:36 +02:00 committed by GitHub
parent 93e747e94e
commit 59df720b81
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/_integrations/paperless_ngx.markdown
View File

@ -22,6 +22,8 @@ The **Paperless-ngx** {% term integration %} allows you to connect your [Paperle
To ensure full functionality of this integration, you must have **read permissions** for all document-related resources, including documents, tags, document types, and correspondents.
To enable monitoring of diagnostic sensors, you must have **administrator permissions**. Without administrator rights, specific API endpoints cannot be accessed, and the sensor states will not be available.
{% details "Create an access token" %}
1. Log in to your **Paperless-ngx** instance.
@ -45,14 +47,22 @@ API key:
This integration provides {% term sensors %} for the following information from Paperless-ngx:
| Sensor | Description |
|--------------------------|--------------------------------------------------------------------------|
| **Correspondents** | Indicates the total number of defined correspondents. |
| **Document types** | Indicates the total number of defined document types. |
| **Documents in inbox** | Indicates the number of documents currently in the inbox. |
| **Tags** | Indicates the total number of defined tags |
| **Total characters** | Indicates the total number of characters extracted from all documents. |
| **Total documents** | Indicates the total number of documents stored. |
| Sensor | Description |
|--------------------------|--------------------------------------------------------------------------------|
| **Correspondents** | Indicates the total number of defined correspondents. |
| **Document types** | Indicates the total number of defined document types. |
| **Documents in inbox** | Indicates the number of documents currently in the inbox. |
| **Tags** | Indicates the total number of defined tags |
| **Total characters** | Indicates the total number of characters extracted from all documents. |
| **Total documents** | Indicates the total number of documents stored. |
| **Total storage** | Indicates the total disk space used by Paperless-ngx. |
| **Available storage** | Indicates the remaining available disk space for Paperless-ngx. |
| **Status database** | Indicates whether the database is reachable and functioning correctly. |
| **Status index** | Indicates whether the document indexing service is operational. |
| **Status classifier** | Indicates whether the document classifier service is running properly. |
| **Status celery** | Indicates whether the Celery task queue is active and processing tasks. |
| **Status redis** | Indicates whether the Redis service used for task queuing is available. |
| **Status sanity** | Indicates the sanity of the Paperless-ngx documents. |
## Removing the integration