Paperless-ng Add-on

omgItsDango · February 16, 2022, 3:52pm

Paperless-ng will not be continued by its owner. A new project has been created which will fork paperless-ng and delevop it with a bigger team.

Paperless-ngx

Proof:

github.com/jonaswinkler/paperless-ng

[Other] Paperless Organization Organization

opened 06:58PM - 13 Feb 22 UTC

qcasey

As seems commonly agreed in #1599, a new Github Organization should be build aro…und this project. Can those willing to do the work of migrating to a GitHub organization for paperless-ng chime in here? ## Currently created Paperless Organizations _Ordered by stars_ 1. paperless-ngx ([repo](https://github.com/paperless-ngx/paperless-ng)) ([people](https://github.com/orgs/paperless-ngx/people)) 2. paperless-reborn ([repo](https://github.com/paperless-reborn/paperless-ng)) ([people](https://github.com/orgs/paperless-reborn/people)) **EDIT:** It appears [paperless-ngx](https://github.com/orgs/paperless-ngx) is the community's choice. The following tasks will be completed there. ## Tasks (unconfirmed) - [x] Invite any willing [paperless-ng contributors](https://github.com/jonaswinkler/paperless-ng/graphs/contributors) to the organization, as they are most familiar with the codebase. - [x] Create the following development teams: - Frontend (Angular) - Backend (Python) - Test (Manually, Docker instances) - Issue Triage - CI/CD (+Automated Testing, +Packaging Docker/Distros) - Translation (+Documentation) - [x] Bring on willing new contributors, invite to any/all relevant teams based on experience. - [x] ~~Migrate issues (??) ([github-issues-import](https://github.com/IQAndreas/github-issues-import)).~~ <-- Decided unideal - [ ] Merge [pending PRs](https://github.com/jonaswinkler/paperless-ng/pulls) after tests and review by contributors (below). ## Confirmed Willing Contributors - @qcasey I can help in organizing this transition, unless anyone else wants to handle. Contributor to [paperless_app](https://github.com/bauerj/paperless_app) and [paperless_share](https://github.com/qcasey/paperless_share). - @a17t Professional experience in Python, Angular, project organization - @isigmund Python (Django/Flask), professional project management - @bauerj Flutter, Python, lead contributor of [paperless_app](https://github.com/bauerj/paperless_app) - @umoenks Test, Translation (en<>de) - @gador Python, Test, Translation (en<>de), Packaging (Docker, Nix) - @sytone Project organization, Project (Issues) - @cleaverm Python (Django), Angular, Packaging (Docker) - @kpj Python, Packaging (Docker), Project (CI/CD) - @azapater Python (Django), Angular/Vue, Translation (en<>es) - @alexander-bauer Python, Project (Infrastructure & Platform) - @shamoon Frontend, [3rd top contributor](https://github.com/jonaswinkler/paperless-ng/graphs/contributors) to paperless-ng - @skorvek Project (Issues, CI/CD) - @FrankStrieter Professional experience Angular - @filcuk Test, Translation (en<>cs) - @slankes Test, Project (Issues, CI/CD, Docs) - @apeltzer Test, Project (Issues) IMO, @jonaswinkler @danielquinn and @shamoon should have write access to this org, as they've all made significant contributions to the paperless project. No one should expect any help from them now, but if they want to contribute in the future it should be made easy.

omgItsDango · April 28, 2022, 7:20am

The addon has been updated to use the Paperless-ngx repository

nickrout · April 28, 2022, 10:02am

And very nice it is too!

tozim · April 29, 2022, 8:46am

Thanks for this addon.

Is there any way to modify some of the paperless settings (e.g. the OCR parameters)?
Or would you have to expose them via the HA config for them to be changeable?

TheBestMoshe · April 29, 2022, 2:40pm

What parameters do you want to modify?

TheBestMoshe · April 29, 2022, 2:41pm

It is now updated to the latest version of Paperless-ngx

Plangin · July 3, 2022, 8:53am

Hey @TheBestMoshe!

Thank you for maintaining this Add-On.

You did not ask me, but I would need the parameter PAPERLESS_URL=<url>.

Background: Using a reverse proxy (Nginx Proxy Manager), I can not reach paperless-ngx from outside. It does always try to redirect to a local address.

Hopefully, setting the correct URL will help.

Thank you

CChris · August 5, 2022, 3:12pm

Hi there,

I am also trying to run the paperless-ngx addon in my homeassistant installation.
At the moment, HomeAssistant is behind a reverse-proxy managed by nginx…

To connect to HomeAssistant, I am just using a domain like:
homeassistant.domain.tld - and I can connect to most addons without any further issues by using my homeassistant URL + adding the “host” behind it -like: homeassistant.domain.tld/f82d1e81_paperless

unfortunately, this seems not to work with the paperless-ngx addon.
So am I right that I need to modify my nginx config to allow port 8000, too?

Plangin · August 7, 2022, 12:55pm

I’m running also into issues with paperless-ngx behind a Nginx Proxy Manager.

Nginx Proxy Manager seems to redirect fine. I enter https://paperless.mydomain.tld into the browser, the login window appears. But after logging in, I’m facing the ‘CSRF verification failed’ error message.

External URL is set in the Addon config and paperless-ngx works great using the local IP and port 8000. Somehow paperless-ngx is not respecting the URL config (I can not check it without being able to set DEBUG=True) or the CNAME setting at my webhosting service for https://paperless.mydomain.tld is causing the issue.

I also opened an Github issue for that:

Just add another proxy host. This is my config:

CChris · August 8, 2022, 7:21am

thanks
I just sorted this out - but probably, I will get a dedicated paperless instance out of HomeAssistant … because I need access to other storage that isn’t available (and should not) within HA.

HappilyOffensive · September 24, 2022, 6:41pm

Will this be updated to the 1.8.0 version?
And, is there the possibility to also get the ssl folder into the container? (I’m using the let’s encrypt addon for TLS certificates)

denilsonsa · September 25, 2022, 12:07am

Quick suggestion: Since it is now using paperless-ngx, it would be a good idea to update the top post from this thread to mention both paperless-ng and paperless-ngx.

Fabian04 · January 14, 2023, 1:51pm

Thanks so much for the Add-on. Would there be a chance to upgrade the addon? I´d also appreciate an explanation how I could open the addon over the remote nabu casa access

Reudiga · February 5, 2023, 1:53pm

Is there a way to get paperless-ngx running on home assistant?

Plangin · February 23, 2023, 9:52am

This is what this whole thread is all about.

It works OK in Home Assistant, but unfortunately the add-on is not maintained anymore and it is stuck at v1.7.0.

There is a fork with a newer version (1.11.2):

But tux2000 did also mention to probably not work actively on updates.

Rudertier · August 8, 2023, 1:37pm

Since tux2000 changed the way he is running Paperless (see details in his repo) I made yet another fork of TheBestMoshe’s Addon.

Plangin · September 25, 2023, 12:53pm

Oh, great. Thank you!

Will switch over there.

Rudertier · September 25, 2023, 2:08pm

Let me know if anything comes up.

BenoitAnastay · September 28, 2023, 11:49am

I forked your repository and I rewrote it to integrate CI, to be coherent with official docker image and I’m cureently working on cleaning up the repo and follow the best practices.

I had to update paperless-ngx with the current dev version because it was updated to python3.11

The repository with a working image : GitHub - BenoitAnastay/home-assistant-addons-repository

navels · October 8, 2023, 6:41pm

@BenoitAnastay I’m running your addon behind a reverse proxy and when accessing it using my external url (paperless.mydomain.org, e.g.) I get

CSRF verification failed. Request aborted.

According to the paperless docs I need to set a docker env variable:

PAPERLESS_URL=paperless.mydomain.org

but I am unclear as to how to do this with your addon. Any suggestions? Thanks!