mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-11 10:21:02 +01:00
71 lines
3.7 KiB
Markdown
71 lines
3.7 KiB
Markdown
# Home assistant add-on: Paperless NG
|
|
|
|
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
|
|
|
|
|
|
|
|
|
|
[](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
|
|
|
|
_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 NG](https://github.com/jonaswinkler/paperless-ng) is a cross-platform free and open-source BitTorrent client.
|
|
This addon is based on the docker image from [linuxserver.io](https://www.linuxserver.io/).
|
|
|
|
## Configuration
|
|
|
|
Options can be configured through two ways :
|
|
|
|
- Addon options
|
|
|
|
```yaml
|
|
GUID: 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: fra,eng #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-ng.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
|
|
|
|
---
|
|
|
|
|