mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
104 lines
5.9 KiB
Markdown
104 lines
5.9 KiB
Markdown
# 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
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/marketplace/actions/super-linter)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
[Paperless NGX](https://github.com/paperless-ngx/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
|
|
|
|
Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
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
|
|
|
|
```yaml
|
|
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)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. 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
|
|
|
|
---
|
|
|
|
|
|
|
|
|