Paperless-ngx
The Paperless-ngx integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to connect your Paperless-ngx
Prerequisites
This integration is only fully supported with Paperless-ngx version 2.15 or later. Earlier versions are not supported.
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.
Create an access token
- Log in to your Paperless-ngx instance.
- In the upper-right corner, select your profile icon.
- Select My Profile.
- Under API Auth Token, select the right Refresh button next to the textbox to generate a new token. Confirm with yes.
- Copy the token and use it during the integration setup in Home Assistant.
Configuration
To add the Paperless-ngx service to your Home Assistant instance, use this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Paperless-ngx.
-
Follow the instructions on screen to complete the setup.
Sensors
This integration provides sensorsSensors return information about a thing, for instance the level of water in a tank. [Learn more] 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. |
| 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
This integration follows standard integration removal. No extra steps are required.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three-dot
menu. Then, select Delete.