mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 18:01:03 +01:00
83 lines
5.0 KiB
Markdown
83 lines
5.0 KiB
Markdown
|
|
# Home assistant add-on: Papermerge
|
|
|
|
|
|
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/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_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
|
|
|
|
Open source document management system (DMS)
|
|
This addon is based on the [docker image](https://hub.docker.com/r/linuxserver/papermerge) from linuxserver.io.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Hass.io add-on.
|
|
|
|
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
|
|
|
|
## 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.
|
|
|
|
Webui can be found at `<your-ip>:8000`.
|
|
|
|
Default name `admin` password `admin`
|
|
|
|
Options can be configured through two ways :
|
|
|
|
- Addon options
|
|
|
|
```yaml
|
|
PGID: user
|
|
GPID: user
|
|
ocrlang: 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).
|
|
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)
|
|
storage_dir: storage dir location (https://papermerge.readthedocs.io/en/v2.0.1/consumption.html)
|
|
import_dir: import dir location (https://papermerge.readthedocs.io/en/v2.0.1/consumption.html)
|
|
imaphost: import from email (https://papermerge.readthedocs.io/en/v2.0.1/consumption.html#imap-email)
|
|
imapusername: import from email (https://papermerge.readthedocs.io/en/v2.0.1/consumption.html#imap-email)
|
|
imappassword: import from email (https://papermerge.readthedocs.io/en/v2.0.1/consumption.html#imap-email)
|
|
CONFIG_LOCATION: location of the papermerge.conf.py (see below)
|
|
```
|
|
|
|
- papermerge.conf.py
|
|
Custom env variables can be added to the /config/addons_config/papermerge/papermerge.conf.py.
|
|
Full variables can be found here : https://papermerge.readthedocs.io/en/v2.0.1/settings.html.
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|
|
|