search

truenas / apps

GNU Lesser General Public License v3.0
74 stars 22 forks source link

Paperless-ngx - Add Tika and Gotenberg #837

Open tina-junold opened 6 days ago

tina-junold commented 6 days ago

Hi,

I would like to see the Paperless-ngx add having additional two containers running, Tika and Gotenberg (docs).

I'm willing to help with a pull request if necessary. The docker-compose.yml of the paperless-ngx project looks like:

    #[...]
    environment:
      PAPERLESS_TIKA_ENABLED: 1
      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
      PAPERLESS_TIKA_ENDPOINT: http://tika:9998

  gotenberg:
    image: gotenberg/gotenberg:latest
    restart: unless-stopped

    # The gotenberg chromium route is used to convert .eml files. We do not
    # want to allow external content like tracking pixels or even javascript.
    command:
      - "gotenberg"
      - "--chromium-disable-javascript=true"
      - "--chromium-allow-list=file:///tmp/.*"

  tika:
    image: docker.io/apache/tika:latest
    restart: unless-stopped
tina-junold commented 6 days ago

@stavros-k This is my first commit in such a big project. Please forgive me if i have not followed some processes correctly.

stavros-k commented 6 days ago

Hello, thanks for wanting to help!

We have this warning on the top of the readme (https://github.com/truenas/apps?tab=readme-ov-file#%EF%B8%8F-contributions) because everything is still going under heavy changes, as you will notice now, all your changes are outdated as I've just updater paperless to v2 lib.

You can probably work with the v2 lib now. Tho its still undocumented but there are tests and few other apps if you want to see examples.

Have you figured yet how to test/render locally? I'm using the following ( you might need to install some python packages)

./.github/scripts/ci.py --app paperless-ngx --train community --test-file basic-values.yaml --wait=true
./.github/scripts/ci.py --app paperless-ngx --train community --test-file basic-values.yaml --render-only=true