Skip to content
View in the app

A better way to browse. Learn more.

Unraid

A full-screen app on your home screen with push notifications, badges and more.

To install this app on iOS and iPadOS
  1. Tap the Share icon in Safari
  2. Scroll the menu and tap Add to Home Screen.
  3. Tap Add in the top-right corner.
To install this app on Android
  1. Tap the 3-dot menu (⋮) in the top-right corner of the browser.
  2. Tap Add to Home screen or Install app.
  3. Confirm by tapping Install.

[Support] Paperless-ngx Docker

Featured Replies

11 hours ago, ALMattSr said:

Screenshot2024-06-11at8_53_45PM.png.e496423513ef2beaea664e6e77d0d8c1.png

 

I am still having an issue with CSRF verification failed when I try to login from a swag reverse proxy instance.  Anyone able to point me in the direction...

You probably have to set the `PAPERLESS_CORS_ALLOWED_HOSTS` variable to the Hostname or IP of your swag container.

  • Replies 290
  • Views 193.7k
  • Created
  • Last Reply

Top Posters In This Topic

Most Popular Posts

  • I installed these 2 containers: Repository: gotenberg/gotenberg Repository: apache/tika In Paperless i added these 3 varibles: Name / Key:    PAPERLESS_TIKA_ENABLED Value:    1

  • Enter your PAPERLESS_REDIS without brackets

  • Unraid 6.11.5, Docker version status for paperless-ngx has been "not available" for around a day. I update these things routinely so it's odd. db-backup docker also in this state but only those 2 (of

Posted Images

On 4/5/2024 at 8:33 AM, volcs0 said:

Did you solve your problem? I have everything on the array, but my docker.img is totally filled up by paperless.  Currently at 13gb, and I just can't figure out why. My setup is like yours. Thoughts?

 

 

 

@Joseph

Same problem. Probably /tmp in the docker is filling up.

 

Try mapping it to a directory outside of docker.img:

image.thumb.png.034eb654f7934e06a10041085f82000c.png

 

That will at least stop the docker.img from growing. You might need a cron job to clean it up regularly.

 

Hi!

 

I'm having the problem that after a recent update paperless doesn't load anymore.

It worked perfectly fine just recently. I'm also able to login and use my Paperless Instance via an the iOS App "Swift Paperless" (Curently in Testflight).

But the webUI just doesn't open anymore. It just says:

image.thumb.png.99753ed155080745c3e6b7ba198c13af.png

 

I already tried restarting the container. No result.

Couldn't find anything in the (linked) documentation, too.

 

Can anyone help me?

 

thanks in advance!

 

EDIT: just tried and I can login with my admin account. It's just my personal account that is stuck on the loading page. I also tried clearing my browser cache and logging in in an incogito window.

 

EDIT2: It works again, after granting my personal user all rights via the admin user.

I didn't need to do this in the past. The rights I added were:

AppConfig

UISettings

History

MailAccount

MailRule

User

 

That doesn't seem to make any sense, to me. Ay ideas?

Edited by juleztb

Kann mir jemand helfen, wie es möglich ist, die Erkennung des QR Code in der Paperless-Dockerdatei für Unraid einzufügen und zu nutzen oder zu starten?

  • Author
On 6/16/2024 at 6:28 PM, foo_fighter said:

@Joseph

Same problem. Probably /tmp in the docker is filling up.

 

Try mapping it to a directory outside of docker.img:

image.thumb.png.034eb654f7934e06a10041085f82000c.png

 

That will at least stop the docker.img from growing. You might need a cron job to clean it up regularly.

 

 

What kind of files fill up the space in the tmp directory? Are the troublesome files in /tmp/paperless or /tmp/paperless-scratch?

 

Can you check if setting PAPERLESS_CONVERT_TMPDIR also works for you? You have to add a bind mount with a physical disk pointing to the same directory too. Using this variable rather than the tmp directory has the benefit that we don't rely on internal knowledge of the application.

 

Based on this discussion:

 

Quote

Typically the OS is responsible cleaninging up /tmp on some sort of schedule or rules based.

 

I guess for Unraid we would need to schedule a dedicated clean up via the User Scripts plugin then. For example:

 

find <PAPERLESS_CONVERT_TMPDIR>/ -mtime +2 -type f -delete

 

I haven't experienced this problem before, because I restart my server on a regular basis. Once the container restarts its tmp directory including the troublesome files should be removed as well. I also do not have a frequent large import volume. However, I see the problem.

 

Waiting for your response. I will then add the variable to the template and further add a paragraph in the first post of this thread about the clean up job.

Edited by T0a

  • Author
4 hours ago, Rops said:

Kann mir jemand helfen, wie es möglich ist, die Erkennung des QR Code in der Paperless-Dockerdatei für Unraid einzufügen und zu nutzen oder zu starten?

 

I have no idea about what feature you are talking about. Can you link the feature you are trying to configure from the paperless-ngx documentation?

On 6/23/2024 at 9:57 AM, T0a said:

 

What kind of files fill up the space in the tmp directory? Are the troublesome files in /tmp/paperless or /tmp/paperless-scratch?

 

Looks like they are all OCR files(I have some large failed PDFs and it seem they don't get cleaned up automatically):

 

root@NAS:/mnt/cache/appdata/paperless-ngx# ls

consume/  data/  export/  media/  tmp/

root@NAS:/mnt/cache/appdata/paperless-ngx# du -sch tmp/

17G tmp/

17G total

root@NAS:/mnt/cache/appdata/paperless-ngx# ls tmp

ocrmypdf.io.0mn2z57f/  ocrmypdf.io.u9o_dd7p/  ocrmypdf.io.zr_nbhp6/  pymp-xzebn3yo/  tmpiajjt4r5/  tmpxvp1v0hq/

ocrmypdf.io.ncd31_t8/  ocrmypdf.io.uil7jtdj/  paperless/             tmp58r7tmpw/    tmpouumc1gz/

root@NAS:/mnt/cache/appdata/paperless-ngx# du -sch tmp/*

4.3G tmp/ocrmypdf.io.0mn2z57f

6.5G tmp/ocrmypdf.io.ncd31_t8

275K tmp/ocrmypdf.io.u9o_dd7p

275K tmp/ocrmypdf.io.uil7jtdj

5.7G tmp/ocrmypdf.io.zr_nbhp6

58M tmp/paperless

1.0K tmp/pymp-xzebn3yo

1.0K tmp/tmp58r7tmpw

1.0K tmp/tmpiajjt4r5

2.0K tmp/tmpouumc1gz

1.0K tmp/tmpxvp1v0hq

17G total

 

I don't have too much RAM so I'll probably not use /tmp.

For cleanup I plan on using a user.script:

#!/bin/bash
/usr/bin/find /mnt/cache/appdata/paperless-ngx/tmp -type f -atime +1 -exec rm -f {} \;

Edited by foo_fighter

 

19 hours ago, Rops said:

Kann mir jemand helfen, wie es möglich ist, die Erkennung des QR Code in der Paperless-Dockerdatei für Unraid einzufügen und zu nutzen oder zu starten?

 

15 hours ago, T0a said:

 

I have no idea about what feature you are talking about. Can you link the feature you are trying to configure from the paperless-ngx documentation?

 

Do you mean ASN Barcodes as in https://docs.paperless-ngx.com/advanced_usage/#archive-serial-number-assignment?

 

Just set `PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE=TRUE` in your Docker .env file or compose file. You will have to use a supported barcode type (listed here: https://docs.paperless-ngx.com/advanced_usage/#barcodes).

 

I wrote a script to generate some barcodes that I could print on a piece of avery labels (see here: https://github.com/tuetenk0pp/asn-barcodes) and while it works, I am not particularly proud of it ;)

  • 2 weeks later...
On 4/3/2024 at 2:15 PM, Zoba said:

I've installed paperless and run into a problem, that my files are stuck in consume. They're being added to the queue but not all of them are being processed, when i add them all at once. Adding PAPERLESS_CONSUMER_POLLING and PAPERLESS_CONSUMER_POLLING_DELAY with 10 seconds each, seems to help a bit but no entirely so.

 

Some files are stuck forever in the consume folder and nothing happens to them. Has anyone else encountered this behaviour?

 

[2024-04-03 23:14:24,083] [INFO] [paperless.management.consumer] Polling directory for changes: /usr/src/paperless/consume

[2024-04-03 23:14:44,087] [DEBUG] [paperless.management.consumer] Waiting for file /usr/src/paperless/consume/Bestätigung der Vertragsbeendigung.pdf to remain unmodified

[2024-04-03 23:14:49,094] [INFO] [paperless.management.consumer] Adding /usr/src/paperless/consume/Bestätigung der Vertragsbeendigung.pdf to the task queue.

my instance which was working before, now also does this where everything is added to the queue but doesn't actually process...

25 minutes ago, giantrobot said:

does this where everything is added to the queue but doesn't actually process...

Make sure your redis container is always started before paperless especially if using appdata backup or such

  • 3 weeks later...

I'm having an issue with importing from email. The email is picked up and then a "File not found" error is generated even though the file exists and is readable.  I tried mapping the /tmp/paperless folder to a directory on my NVME cache and I still get the same error.  I've verified the file exists.  Uploading files manually through the GUI works fine, as does dropping files into the consume folder.  It's not a problem with the mail configuration as it logs in, finds the email in the folder that's specified, but then it can't import it.  I've tried PDFs and TXT files.

[2024-07-30 15:26:37,465] [ERROR] [celery.app.trace] Task documents.tasks.consume_file[de32a73d-cd1f-4258-bbb0-e31a48763203] raised unexpected: ConsumerError('HUH721010ALE601_1SG01DEZ-20240729-1328.txt: Cannot consume /tmp/paperless/paperless-mail-9eld5bt0/HUH721010ALE601_1SG01DEZ-20240729-1328.txt: File not found.')
Traceback (most recent call last):
  File "/usr/local/lib/python3.11/site-packages/celery/app/trace.py", line 453, in trace_task
    R = retval = fun(*args, **kwargs)
                 ^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/celery/app/trace.py", line 736, in __protected_call__
    return self.run(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/asgiref/sync.py", line 327, in main_wrap
    raise exc_info[1]
  File "/usr/src/paperless/src/documents/tasks.py", line 151, in consume_file
    msg = plugin.run()
          ^^^^^^^^^^^^
  File "/usr/src/paperless/src/documents/consumer.py", line 505, in run
    self.pre_check_file_exists()
  File "/usr/src/paperless/src/documents/consumer.py", line 309, in pre_check_file_exists
    self._fail(
  File "/usr/src/paperless/src/documents/consumer.py", line 302, in _fail
    raise ConsumerError(f"{self.filename}: {log_message or message}") from exception
documents.consumer.ConsumerError: HUH721010ALE601_1SG01DEZ-20240729-1328.txt: Cannot consume /tmp/paperless/paperless-mail-9eld5bt0/HUH721010ALE601_1SG01DEZ-20240729-1328.txt: File not found.
root@unRAID:/mnt/nvme/dockerApps/paperless-ngx/tmp/paperless-mail-9eld5bt0# ls -l
total 5
-rw-r--r-- 1 root root 208 Jul 30 15:26 HUH721010ALE601_1SG01DEZ-20240729-1328.txt

 

Any suggestions would be appreciated!

Edited by Doug Eubanks

  • 3 weeks later...

I have installed redis no problem it seems

Quote

redis 22:24:03.54 INFO  ==>
redis 22:24:03.55 INFO  ==> Welcome to the Bitnami redis container
redis 22:24:03.55 INFO  ==> Subscribe to project updates by watching https://github.com/bitnami/containers
redis 22:24:03.56 INFO  ==> Submit issues and feature requests at https://github.com/bitnami/containers/issues
redis 22:24:03.56 INFO  ==> Upgrade to Tanzu Application Catalog for production environments to access custom-configured and pre-packaged software components. Gain enhanced features, including Software Bill of Materials (SBOM), CVE scan result reports, and VEX documents. To learn more, visit https://bitnami.com/enterprise
redis 22:24:03.56 INFO  ==>

1:C 15 Aug 2024 22:24:03.604 # WARNING Memory overcommit must be enabled! Without it, a background save or replication may fail under low memory condition. Being disabled, it can also cause failures without low memory condition, see https://github.com/jemalloc/jemalloc/issues/1328. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.
1:C 15 Aug 2024 22:24:03.604 * oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
1:C 15 Aug 2024 22:24:03.604 * Redis version=7.4.0, bits=64, commit=00000000, modified=1, pid=1, just started
1:C 15 Aug 2024 22:24:03.604 * Configuration loaded
1:M 15 Aug 2024 22:24:03.605 * monotonic clock: POSIX clock_gettime
1:M 15 Aug 2024 22:24:03.606 * Running mode=standalone, port=6379.
1:M 15 Aug 2024 22:24:03.606 * Server initialized
1:M 15 Aug 2024 22:24:03.606 * Ready to accept connections tcp

 

With paperless when i start im getting an error

Waiting for Redis...
Redis ping #0 failed.
Error: Authentication required..
Waiting 5s
Redis ping #1 failed.
Error: Authentication required..
Waiting 5s
Redis ping #2 failed.
Error: Authentication required.

 

 

Sounds like you've set a password on the redis container but didn't give it to paperless.

1 hour ago, Kilrah said:

Sounds like you've set a password on the redis container but didn't give it to paperless.

i did both. set a password and put  it on the allow without password "yes" and changed it on paperless also to the redis:pass@ip:port

10 hours ago, KoNeko said:

i did both. set a password and put  it on the allow without password "yes" and changed it on paperless also to the redis:pass@ip:port

I got it working. what i forgot was giving the user.  so redis:default:password@ip:port

Hi, 

still kind of new to Unraid. I have some containers running fine (Immich, Nextcloud, Paperless-NGX) All of these are shared to my Linux desktop through SMB. Just that only on Paperless-NGX I cannot see any content (see screenshot of setup) I checked and could not find any difference in how e.g. Nextcloud and Paperless are set up regarding shares. But the folders in the Paperless-NGX share don't populate. 

2024-08-18_14-05.png

I want to implement a post consumtion script to my paperless-ngx. But i cannot find the config file to set the script... can somebody tell me where to find this config file?

First I want to say thank you for this container! It works fine and was easy to setup. Thank you for that!

 

But I also have a question regarding Paperless-ngx itself: How does paperless decide where to put the documents if you are running a multi user setup? I scan or upload documents to the consume folder and sometimes the documents show up on "User A" and sometimes "User B" gets the documents.

  • 2 weeks later...

Is it possible to add wget to the docker container? During using PAPERLESS_POST_CONSUME_SCRIPT it would be nice to send data to a local webserver for further processing.

 

I tried to use the following post-consume-script:

 

#!/usr/bin/env bash

if ! which wget >/dev/null ; then
    echo "Installing wget ..."
    apt-get install wget
fi

wget --output-document=/dev/stdout http://192.168.70.91:88/dms/public/consume/${DOCUMENT_ID}

 

This works in the console window but not if it is called by paperlessNGX, because in the last case wget will not be installed. Or is there a workaround?

 

4 hours ago, Yasheena said:

Is it possible to add wget to the docker container? During using PAPERLESS_POST_CONSUME_SCRIPT it would be nice to send data to a local webserver for further processing.

 

This works in the console window but not if it is called by paperlessNGX, because in the last case wget will not be installed. Or is there a workaround?

 

Just an idea, haven't tried it:

 

https://docs.paperless-ngx.com/advanced_usage/#consume-hooks

 

Custom Container Initialization

The Docker image includes the ability to run custom user scripts during startup. This could be utilized for installing additional tools or Python packages, for example. Scripts are expected to be shell scripts.

To utilize this, mount a folder containing your scripts to the custom initialization directory, /custom-cont-init.d and place scripts you wish to run inside. For security, the folder must be owned by root and should have permissions of a=rx. Additionally, scripts must only be writable by root.

Your scripts will be run directly before the webserver completes startup. Scripts will be run by the root user. If you would like to switch users, the utility gosu is available and preferred over sudo.

This is an advanced functionality with which you could break functionality or lose data. If you experience issues, please disable any custom scripts and try again before reporting an issue.

For example, using Docker Compose:

services: # ... webserver: # ... volumes: - /path/to/my/scripts:/custom-cont-init.d:ro

 

 

Could you not use this to install wget? Again, haven't tried it...

Edited by Wimpie

  • 2 weeks later...

Hi Guys,

Is it possible to change the location of the Data, Media and consumption folder. If so how do i move them? I have had a look on the doc website but not seen anything.

My goal is to change the locations and use the new location for the consumption to mount my webdav. I installed the apache webdav which is working however i've had difficulty with mounting it in my current consumption folder.

T.I.A

On 6/11/2024 at 9:55 PM, ALMattSr said:

Screenshot2024-06-11at8_53_45PM.png.e496423513ef2beaea664e6e77d0d8c1.png

 

I am still having an issue with CSRF verification failed when I try to login from a swag reverse proxy instance.  Anyone able to point me in the direction...

 

On 6/12/2024 at 9:27 AM, Tuetenk0pp said:

You probably have to set the `PAPERLESS_CORS_ALLOWED_HOSTS` variable to the Hostname or IP of your swag container.

@ALMattSrdid you find a solution for this? Same thing just started happening to me going through ngin-x. It seems to work fine in the Swift Paperless app, but logging in through the web browser gets the same Forbidden message. I tried adding the PAPERLESS_CORS_ALLOWED_HOSTS variable and setting it to the IP of the ngin-x container, but I get the same result.

  • 2 weeks later...

Server Error 500 after update

Hey folks, I'm still relatively new to the whole docker game and am struggling a bit since an update. I'm getting a "Server Error 500" when logging into paperless now which used to work perfectly fine before.

 

What happens:

  1. Open paperless login page (works perfectly) (Screenshot 1)
  2. login with username / password
  3. Get blank Server Error 500 Page (Screenshot 2)

Workaround:

  1. I noticed i can go to the /admin-URL, login to the django admin backend with my credentials just fine.
  2. From there I can click the "show website" link and open my paperless dashboard
  3. However all thumbnails are missing
  4. If I open the web inspector and check the link to the thumbnail, all thumbnails also get an "Server Error 500"-Page.

What I tried:

  1. Restart containers (including Redis) , didn't work 😔 
  2. Restart unraid server , didn't work 😔 
  3. Delete and re-install container , didn't work 😔 

Not sure what the logs suggest. To me it sounds like some python files have errors but I highly doubt that. But then again I might not know enough about logs n pythons n stuff 😂

 

Would anyone have an idea what might be the problem with my paperless installation? I'm really out of ideas with this one. 😢  – Any help is greatly appreciated 🤗

 

Login-Page:
Paperless-Login-Step-1.thumb.png.d9d1c1449dda887424202b8034fb7684.png

Login-page after clicking "Login/Anmelden" with correct credentials:

Paperless-Login-Step-2.thumb.png.831db848e208022861d5fde87491fbfb.png

Dashboard with no thumbnails:

Dashboard.thumb.png.7526ccf5434a0ace3b2bb69fea2cafd3.png

 

Thumbnail path opened in browser:

Thumbnailpath.thumb.png.78fc9077fdc93789ff0729947f85de74.png

 

Log from container start to login:

paperless-ngx-2024-10-04.log

 

Can someone help? Im on Paperless-ngx 2.5.3. It says in the web GUI there is an update but unraid docker says "version: 

 not available"

 

My repo is set to: ghcr.io/paperless-ngx/paperless-ngx:latest

 

How can i update and keep it up to date with future versions?

 

All other dockers are up to date. Diagnostic log files attached.

tower-diagnostics-20241006-1447.zip

7 minutes ago, Viper82 said:

Can someone help? Im on Paperless-ngx 2.5.3. It says in the web GUI there is an update but unraid docker says "version: 

 not available"

 

My repo is set to: ghcr.io/paperless-ngx/paperless-ngx:latest

 

How can i update and keep it up to date with future versions?

 

All other dockers are up to date. Diagnostic log files attached.

tower-diagnostics-20241006-1447.zip 112.11 kB · 0 downloads

 

UPDATE:  I forced the update in advanced mode and that seems to have done the trick. I wonder if it will stay up to date now??

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

Account

Navigation

Search

Search

Configure browser push notifications

Chrome (Android)
  1. Tap the lock icon next to the address bar.
  2. Tap Permissions → Notifications.
  3. Adjust your preference.
Chrome (Desktop)
  1. Click the padlock icon in the address bar.
  2. Select Site settings.
  3. Find Notifications and adjust your preference.