---
title: "Paperless-ngx"
description: "Paperless-ngx is a built-in integration for Home Assistant. It has 1.9k installs sharing analytics and works locally."
canonical: "https://vulpo.app/integrations/core/paperless-ngx"
url: "https://vulpo.app/integrations/core/paperless-ngx.md"
last-updated: "2026-10-22"
version: "1.4"
---

# Paperless-ngx

> Paperless-ngx is a built-in integration for Home Assistant. It has 1.9k installs sharing analytics and works locally.

Paperless-ngx is a built-in integration that connects Home Assistant to a Paperless-ngx document management server. It talks to the instance locally through its API, using an API key and the server URL entered in the UI. It adds sensors for document totals, documents in the inbox, correspondents, document types, total characters and available storage. Further sensors report the status of components such as Celery, the classifier, the database, the index, Redis and the sanity check. An update entity shows the state of the Paperless-ngx software. The SSL certificate check can be turned off for self-signed certificates, and connection settings can be changed later without removing the entry.

Automatic summary of Home Assistant's source code. Something wrong? [Get in touch](https://vulpo.app/contact)

[Open in My Home Assistant](https://my.home-assistant.io/redirect/config_flow_start/?domain=paperless_ngx)

## Supports

- **Works locally**: Talks to your devices on your own network. No vendor cloud in between.
- **Set up in the UI**: Add it in Settings, Devices and services. Nothing to download.
- **Change settings later**: Its connection settings can change without removing it.
- **Platinum quality**: Home Assistant's own rating of its code and setup experience.
- **Updated with Home Assistant**: Ships and updates with every Home Assistant release.

## Setting it up

It is added under Settings, Devices and services, with Add integration.

### Add Paperless-ngx instance

- **API key**: API key to connect to the Paperless-ngx API
- **URL**: URL to connect to the Paperless-ngx instance
- **Verify SSL certificate**: Verify the SSL certificate of the Paperless-ngx instance. Disable this option if you’re using a self-signed certificate.

Also asked when changing the connection.

### Re-auth Paperless-ngx instance

- **API key**: API key to connect to the Paperless-ngx API

Texts from Home Assistant's source code, [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

## Entities

- **Sensors**: Status Celery, Total characters, Status classifier, Correspondents, Status database, Document types, Documents in inbox, Total documents, Status index, Status Redis, Status sanity, Available storage, and 2 more
- **Updates**: Software

## Troubleshooting

- **Diagnostics**: Downloads a diagnostics file to attach to a bug report.

## At a glance

- Kind: Built-in integration
- Category: [Productivity and information](https://vulpo.app/integrations/category/productivity-and-information.md), Documents and photos
- Brand: [Paperless-ngx](https://vulpo.app/integrations/paperless-ngx.md)
- Number: 1.9k installs sharing analytics
- Connection: Works locally
- Upkeep: Part of Home Assistant
- Needs: Built into Home Assistant
- Quality scale: Platinum quality scale
- Domain: `paperless_ngx`
- Source: <https://www.home-assistant.io/integrations/paperless_ngx/>

In Vulpo: Chart card, Apple Watch

## Other ways in for Paperless-ngx

| Name | Kind | Installs or stars | Connection | Upkeep |
| --- | --- | --- | --- | --- |
| [Paperless-ngx](https://vulpo.app/integrations/apps/paperless-ngx.md) | App | 2.3k installs sharing analytics | Connection not stated | Updated in the last 6 months |
| [zzz\_archived - Paperless NGX](https://github.com/alexbelgium/hassio-addons) | App | 19 installs sharing analytics | Connection not stated | Updated in the last 6 months |

Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation. [About these numbers](https://vulpo.app/integrations/about)

Last updated 2026-10-22. Source: https://vulpo.app/integrations/core/paperless-ngx

---

- HTML version of this page: https://vulpo.app/integrations/core/paperless-ngx
- Site index for agents: https://vulpo.app/llms.txt
- Everything in one document: https://vulpo.app/llms-full.txt
- All pages: https://vulpo.app/sitemap.xml