Extended Paperless-ngx docs (#40012)

fvgarrel · c0ffeeca7 · web-flow · commit 1b9564121f43 · 2025-07-31T07:04:11.000Z
Co-authored-by: c0ffeeca7 &lt;38767475+c0ffeeca7@users.noreply.github.com&gt;
diff --git a/source/_integrations/paperless_ngx.markdown b/source/_integrations/paperless_ngx.markdown
@@ -54,6 +54,16 @@ Verify SSL certificate:
   description: "Verify the SSL certificate of the Paperless-ngx instance. Disable this option if you're using a self-signed certificate."
 {% endconfiguration_basic %}
 
+## Use cases
+
+The integration can be used to build automations to help and notify you of new documents in your paperless instance.
+The update sensor could notify you if a new paperless-ngx version is available.
+
+## Supported functionality
+
+The Paperless-ngx integration provides statistic and diagnostic entities to Home Assistant.
+Below is an overview of these entities and their function.
+
 ## Sensors
 
 This integration provides {% term sensors %} for the following information from Paperless-ngx:
@@ -76,9 +86,86 @@ This integration provides {% term sensors %} for the following information from
 | **Status sanity**        | Indicates the sanity of the Paperless-ngx documents.                           |
 | **Software**             | Indicates whether a new Paperless-ngx update ist available.                    |
 
+## Example automations
+
+{% details "Send a push notification if a new document is available" %}
+{% raw %}
+
+```yaml
+alias: New document push notification
+description: Sends a push notification if a new document is available
+triggers:
+  - entity_id: sensor.paperless_documents_inbox
+    to: null
+    trigger: state
+conditions:
+  - condition: template
+    value_template: |
+      {% if trigger.from_state is not none and trigger.to_state is not none %}
+        {{ trigger.to_state.state > trigger.from_state.state }}
+      {% else %}
+        false
+      {% endif %}
+actions:
+  - action: notify.mobile_app_iphone
+    metadata: {}
+    data:
+      message: A new document is available.
+```
+
+{% endraw %}
+{% enddetails %}
+
+## Data updates
+
+This integration retrieves data using a pull-based mechanism.
+
+- **Statistic sensors** are pulled every **120 seconds**  
+- **Diagnostic sensors** are pulled every **300 seconds**  
+- **Update checks** to detect new Paperless-ngx versions are performed **every 24 hours**
+
+## Known limitations
+
+There are a few known limitations for using the integration:
+
+- This integration is only fully supported with **Paperless-ngx version 2.15 or later**. Earlier versions are not supported.
+- 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.
 
 ## Removing the integration
 
 This integration follows standard integration removal. No extra steps are required.
 
 {% include integrations/remove_device_service.md %}
+
+## Troubleshooting
+
+{% details "Message: 'Invalid hostname or IP address'" %}
+
+If you get the message **Invalid hostname or IP address**, try the following steps:
+1. Make sure you enter a complete URL, such as `https://paperless.example.com` or `https://192.168.178.11:8011`.
+
+2. SSL is enabled by default. If you're using an unencrypted connection, you must explicitly use `http://` instead of `https://` in the URL.
+
+3. If you're using a self-signed certificate, disable the **Verify SSL certificate** option.
+
+{% enddetails %}
+
+{% details "Message: 'The token does not have permission to access the API'" %}
+
+If you get the message **The token does not have permission to access the API**, try the following steps:
+1. Verify whether the token is still valid and correctly assigned to the user.
+
+2. Test the token using the Swagger interface available at
+`https://paperless.example.com/api/schema/view/`
+   - Click on **"Authorize"** in the Swagger UI to enter your token at **tokenAuth (apiKey)**.
+   - Then, try accessing the relevant endpoints like `/api/statistics/` to ensure they respond as expected.
+
+3. If everything works correctly in Swagger but the integration still fails, check whether a reverse proxy (e.g., NGINX) is returning an **HTTP 403 error**. If so, the integration may also report this as a permission issue.
+
+{% enddetails %}
+
+## Removing the integration
+
+This integration follows standard integration removal, no extra steps are required.
+
+{% include integrations/remove_device_service.md %}
