zzz_archived_paperless_ngx

Home assistant add-on: Paperless NGX

⚠️ It is recommended to use this new addon (https://github.com/BenoitAnastay/home-assistant-addons-repository). It is more robust and has more functions. ⚠️

Migration (thanks @eikeja) :

• Install the new addon
• Make a backup of the old Paperless directory. In my case "/addon_configs/db21ed7f_paperless_ng"
• View the folder structure of the new instance, assign files from the old instance to the folders of the new instance.

Start new Paperless - all data is there!

Folder assignment: /addon_configs/db21ed7f_paperless_ng/data → /addon_configs/ca5234a0_paperless-ngx/data

/addon_configs/db21ed7f_paperless_ng/media → /share/paperless

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

About

Paperless NGX is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.

Alternative quality addon : https://github.com/BenoitAnastay/home-assistant-addons-repository/tree/main/paperless-ngx

Configuration

Default username:password is admin:admin. Once logged in, you can change it from within the administration panel.

Options can be configured through two ways :

• Addon options

PGID: user
GPID: user
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
networkdisks: "<//SERVER/SHARE>" # list of smbv2/3 servers to mount (optional)
cifsusername: "username" # smb username (optional)
cifspassword: "password" # smb password (optional)
CONFIG_LOCATION: Location of the config.yaml (see below)
OCRLANG: eng fra #Any language can be set from this page (always three letters) [here](https://tesseract-ocr.github.io/tessdoc/Data-Files#data-files-for-version-400-november-29-2016).
TZ: Europe/Paris # Sets a specific timezone

• Config.yaml

Custom env variables can be added to the config.yaml file referenced in the addon options. Full env variables can be found here : https://paperless-ngx.readthedocs.io/en/latest/configuration.html. It must be entered in a valid yaml format, that is verified at launch of the addon.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
2. Install this add-on.
3. Click the Save button to store your configuration.
4. Set the add-on options to your preferences
5. Start the add-on.
6. Check the logs of the add-on to see if everything went well.
7. Open the webUI and adapt the software options

Integration with HA

No specific integration, it is a self hosted system

Support

Create an issue on github

Illustration

---