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-ng Docker

Featured Replies

1 hour ago, mattie112 said:

 

Let me know how it works :)

 

As I don't have a test installation I wanted to hear from someone else that it's working ;-)

  • Replies 223
  • Views 96.8k
  • Created
  • Last Reply

Top Posters In This Topic

Most Popular Posts

  • Yes, I went through this a few months back! Here is the relevant doc page and section: https://paperless-ng.readthedocs.io/en/latest/administration.html#managing-filenames   Specific instruc

  • CorneliousJD
    CorneliousJD

    Really just want to say THANKS for bringing this template to the community. Paperless (OG) left something to be desired for me, but Paperless-ng really does what I want and has the look/feel I was aft

  • Ford Prefect
    Ford Prefect

    another plus is, that this docker uses a different method on checking the "consume" inbound directory for new documents. Although I pointed this dir to a standard user share (including cache = YE

Posted Images

Hello all,

to all the people asking a question regarding swapping paperless-ng with paperless-ngx, I did it. And it is working fine.

 

My old docker setup:

- paperless-ng

- mariadb as database

- consume directory

- data directory

 

I just swap the docker endpoint with new one and it working fine. And also if you are following “ngx” it is supposed to be drop-in replacement for current “ng”. Hope this helps. 

  • 2 weeks later...

EDIT: Found a solution

I ran paperless on its own IP-adress and therefore it couldn't communicate with redis. 

 

=================================0

 

Hi guys, 

 

my consumer has stopped working. This is what the protocol says: 

 

2022-03-25 09:38:16,480] [INFO] [paperless.management.consumer] Adding /usr/src/paperless/src/../consume/document_title.pdf to the task queue.

[2022-03-25 09:38:19,546] [ERROR] [paperless.management.consumer] Error while consuming document

Traceback (most recent call last):

  File "/usr/local/lib/python3.9/site-packages/redis/connection.py", line 559, in connect

    sock = self._connect()

  File "/usr/local/lib/python3.9/site-packages/redis/connection.py", line 615, in _connect

    raise err

  File "/usr/local/lib/python3.9/site-packages/redis/connection.py", line 603, in _connect

    sock.connect(socket_address)

OSError: [Errno 113] No route to host

During handling of the above exception, another exception occurred:

Traceback (most recent call last):

  File "/usr/src/paperless/src/documents/management/commands/document_consumer.py", line 64, in _consume

    async_task(

  File "/usr/local/lib/python3.9/site-packages/django_q/tasks.py", line 73, in async_task

    enqueue_id = broker.enqueue(pack)

  File "/usr/local/lib/python3.9/site-packages/django_q/brokers/redis_broker.py", line 18, in enqueue

    return self.connection.rpush(self.list_key, task)

  File "/usr/local/lib/python3.9/site-packages/redis/client.py", line 2016, in rpush

    return self.execute_command('RPUSH', name, *values)

  File "/usr/local/lib/python3.9/site-packages/redis/client.py", line 898, in execute_command

    conn = self.connection or pool.get_connection(command_name, **options)

  File "/usr/local/lib/python3.9/site-packages/redis/connection.py", line 1192, in get_connection

    connection.connect()

  File "/usr/local/lib/python3.9/site-packages/redis/connection.py", line 563, in connect

    raise ConnectionError(self._error_message(e))

redis.exceptions.ConnectionError: Error 113 connecting to 192.168.178.36:6379. No route to host.

[2022-03-25 09:38:19,552] [INFO] [paperless.management.consumer] Using inotify to watch directory for changes: /usr/src/paperless/src/../consume

 

I have tried reinstalling paperless-ng and redis, have installed a fresh paperless-ngx docker and imported all of my documents. And even switched from library/redis to bitnami/redis:latest. 

What could be the issue?

 

Redis is running, the port and IP are fine and have been working in the past. 

Edited by Dorsch

Can paperless be configured in anyway to accept documents with the same filename in the consume folder? Obviously windows can't but at least at different times.

 

To test this I make 2 files called 'statement' each with different content. Put one in the consume folder and waited for it to be processed then put the other in, but then nothing happens with the 2nd statement file.

  • 4 weeks later...

Running NGX.

Ran in to a know bug. See quote below.

https://github.com/paperless-ngx/paperless-ngx/issues/817

 

Same Problem here with unraid
Upgraded to 1.7.0 => error when try to connect with URL and nginx proxy manager
1.7.0 local access with IP => no problems
Downgrade to 1.6.0 => no problems

 

Question - How do I downgrade to 1.6.0 as well. So my system is accessible through the net and NPM.

Thanks

 

RESOLVED

https://github.com/paperless-ngx/paperless-ngx/issues/712

Edited by Profezor

  • 1 month later...

Hello,

 

i am to newbie to simply start the command for retagging my correspondents:

 

How do i execute this command?

https://paperless-ng.readthedocs.io/en/latest/administration.html#document-retagger

 

In Django / Admin Page the cron job does not start.. Maybe i have to do this in unraid terminal? But how and where?

 

Thank you for your help.

 

The command:

 

document_retagger [-h] [-c] [-T] [-t] [-i] [--use-first] [-f] optional arguments: -c, --correspondent -T, --tags -t, --document_type -i, --inbox-only --use-first -f, --overwrite

 

  • 3 weeks later...
On 6/17/2022 at 3:00 PM, Raptor2k said:

Hello,

 

i am to newbie to simply start the command for retagging my correspondents:

 

How do i execute this command?

https://paperless-ng.readthedocs.io/en/latest/administration.html#document-retagger

 

In Django / Admin Page the cron job does not start.. Maybe i have to do this in unraid terminal? But how and where?

 

Thank you for your help.

 

The command:

 

document_retagger [-h] [-c] [-T] [-t] [-i] [--use-first] [-f] optional arguments: -c, --correspondent -T, --tags -t, --document_type -i, --inbox-only --use-first -f, --overwrite

 

 

Found a solution:

 

In Unraid > Docker > Start Console:

 

cd /app/paperless/src

python3 manage.py document_retagger -c 

 

  • 3 months later...

Hi guys,

 

I missed some files I sent via email to get fetched from my paperless and it showed this in the mail log:

 

Selecting folder INBOX
Searching folder with criteria (SINCE 12-Sep-2022)
Processing mail  from [email protected] with 1 attachment(s)
Skipping attachment 444545.pdf with content disposition inline

 

EDIT (SOLUTION):

 

It seems that Apple Mail (where I sent my stuf from) on iphone now only sends files inline, even PDFs. I had to say paperless to also grap the inline stuff in order to make it process the mails. 

 

image.png.b7608a21d80f55ada4d85a148eb2413a.png

 

Edited by Retrogamer137

  • 2 months later...

Hi,

For some reasons I can't really explain, I lost a good number of thumbnails in the document view.
Is there a way I can regenerate them?

Thank you.

Edited by cam217

  • 1 month later...

Perhaps I need something explained to me about how Paperless-NGX works but I feel like I'm missing something.

 

When I scan a document I would like to have the newest documents I've added appear on my front page. my assumption is this is under the "Added" filter under documents, however I'll scan and add a document and have the filter set to "Last 7 Days" and documents I scan today won't show up. Is that filter set to the previous day and back 7 days from that?

Guessing here. The document date is being picked up via something it thinks is a document date after OCRing it. I suspect if you look at the document properties in p-ngx you might see the connection.

 

I have my new documents tagged with "inbox" automatically so I can easily find them when I use the web app. Then I can update the metadata and remove the inbox tag.

  • 2 weeks later...

Hi

 

My Docker overview shows "not available" since somewhen recently

 

Any chance to understand why/how this may have happened?

 

Thx!

 

daNick
  

Bildschirm­foto 2023-02-14 um 21.42.28.png

  • 2 months later...

RESOLVED the issue

I can now get the paperless-ngx login page to show.

 

but i get this error (image)

 

this is my swag proxy conf file

 

server {
    listen 443 ssl;
    listen [::]:443 ssl;

    server_name paperless-ngx.*;

    include /config/nginx/ssl.conf;

    client_max_body_size 0;

    # enable for ldap auth, fill in ldap details in ldap.conf
    #include /config/nginx/ldap.conf;

    # enable for Authelia
    include /config/nginx/authelia-server.conf;

    #Organizr ServerAuth
    #include /config/nginx/proxy-confs/organizr-auth.subfolder.conf;
    #auth_request /auth-0;

    location / {
        # enable the next two lines for http auth
        # auth_basic "Restricted";
        # auth_basic_user_file /config/nginx/.htpasswd;

        # enable the next two lines for ldap auth
        # auth_request /auth;
        # error_page 401 =200 /ldaplogin;

        # enable for Authelia
        # include /config/nginx/authelia-location.conf;

        include /config/nginx/proxy.conf;
        resolver 127.0.0.11 valid=30s;
        set $upstream_app 192.168.10.220;
        set $upstream_port 8000;
        set $upstream_proto http;
        proxy_pass $upstream_proto://$upstream_app:$upstream_port;

        # REMOVE THIS LINE BEFORE SUBMITTING: Additional proxy settings such as headers go below this line, leave the blank line above.
    }

}

 

paperless.png

 

EDIT

 

Found the answer here

https://github.com/paperless-ngx/paperless-ngx/issues/712

Edited by Greygoose

  • 2 months later...
On 1/2/2021 at 2:24 PM, T0a said:

  logo-dark.png

 

Overview: Dedicated support thread for the Docker template paperless-ng provided via the selfhosters/unRAID-CA-templates repository.

Project Page: https://github.com/jonaswinkler/paperless-ng

Documentation: https://paperless-ng.readthedocs.io/en/latest/

Registry: https://hub.docker.com/r/jonaswinkler/paperless-ng/

Changelog: https://paperless-ng.readthedocs.io/en/latest/changelog.html

 

This is the official paperless-ng Docker support thread. Feel free to ask questions, share your experience with paperless-ng or describe your paperless setup at home. I try to update this main post regularly based on your feedback. From here on, I will use the terms paperless and paperless-ng interchangeable.

 

1. What is paperless-ng and how does it differ from the original paperless?

Paperless-ng is a fork of paperless, adding a new interface and many other changes under the hood. The original project paperless hasn't received a lot of updates and bug fixes in the past. Even pull requests are not merged for some time now (Update: 26.08.2021, The old paperless repository has been archived).

 

Here are a few key features of paperless-ng:

  • New front end build with Angular. It features full text search with scored and highlighted results, savable filters, a dashboard, and document uploading on the landing page

  • Mobile support is also almost there. Some layouts don't work yet on small screens

  • New mail consumer that supports multiple accounts and custom filters and actions. Fully tested!

  • Paperless-ng trains a neural network on your documents and assigns tags and correspondents automatically, if you instruct it to do so

  • Updated dependencies

  • More tests of critical backend parts

  • A proper task processing queue that can consume multiple documents in parallel. Consumption of many documents is now blazing fast on multi core system. Fixed much of the consumer code, so that it does not block the database during consumption, for instance

 

2. How to Install

  • Download and install a Redis container from the community application store (CA)
  • Download and configure the paperless-ng container from the CA
    • Make sure you point the container to your Redis instance. Use your actual IP and not localhost, because the reference is resolved in the container. In case you need to pass a password to Redis, use the following connection string redis://:[PASSWORD]@[IP]:6379 instead. At the moment Redis doesn't support users and only provides authentication against a global password. You can pass anything as a username, including the empty string as in my example here. To configure a password for your Redis container, set 'redis-server --requirepass "your-secret"' as post arguments on the Redis docker container. Also make sure to not use any special characters. Otherwise, the connection string might not be readable by paperless.
  • Create a user account after this container is created i.e. from Unraids Docker UI, click the paperless-ng icon and choose Console. Then enter the command "python manage.py createsuperuser" in the prompt and follow the instructions. Alternative, set 'PAPERLESS_ADMIN_USER' and 'PAPERLESS_ADMIN_PASSWORD' in your paperless-ng docker template. With the later approach, it might be easier to find your password to sensible documents stored in paperless.

 

3. My personal workflow

I use the iOS app ScannerPro to scan my documents and upload them via the app to a web DAV target on my Unraid server. The web DAV target is then mounted in the container as consume directory. Further, I use the pre and post hooks to execute web hooks in order to check via Home Assistant whether the processing failed for a uploaded document. Home Assistant sends then notifications about the import status to my phone. This way I can throw away the physical document without worrying about it being not imported.

 

How does your workflow look like? Feel free to share it in this thread. Here you can also find the official recommended workflow for managing your documents with paperless-ng.

 

4. FAQ

 

4.1 Why does the consumer not pick up my files?

The consumer service uses `inotify` to detect new documents in the consume folder. This subsystem, however, does not support NFS shares. You can disable `inotify` and use a time-based polling mechanism instead (see `PAPERLESS_CONSUMER_POLLING`. If set to a value n greater than 0, inotify is disabled and the directory is polled every n seconds).

 

4.2 How to customize paperless-ng?

Paperless-ng does support much more environment variables than the Unraid template offers. You can find them in the documentation here.

 

4.3 What scanner do you use for paperless-ng at home?

A list of scanners used by our community:

  • iPhone with ScannerPro app; one time purchase (@T0a)
  • More will be added when you share your scanner

Paperless-ng also maintains a list of recommended scanners. Feel free opening a pull request over there to add your recommended scanner to the documentation too.

 

4.4 Can I use paperless-ng on a mobile device?

Mobile support in paperless-ng is also almost there. Some layouts don't work yet on small screens. There is also a mobile app in pretty early development stage. Though, it is only available on the Android store yet.

 

4.5 What is the future of the original paperless template in Unraid?

At some point, I will probably remove the paperless template and close its support thread.

 

4.6 How to configure PostgreSQL as a database?

See this post on how to configure PostgreSQL in the template. The official documentation gives further migration steps needed.

 

Hi, the docs link does not work anymore.

  • 4 months later...

No write permission in consume folder

 

I still do not get my write permission issue managed after reading all posts. paperless is running great, but I am not able to manually put a file in the consume folder on the SMB share as I am always told I am missing the permission to do so.

I have received the UID 0 when using echo $UID in the console, the docker is running with the default values 99 and 100.

You cannot put a file in a SMB share? Or your paperless has problems accessing a folder?

 

The first one is not a paperless issue so perhaps worth a separate post?

 

In the Unraid Tools menu there is a "(docker safe) new permissions" option that might fix your issue.

  • 4 months later...

Hello

I am in need of some help i have gone down the postgres route and both postgres and paperless-ngx start up and logs to me look fine but i cannot get the web gui to load!

 

Here are logs from both containers see HERE

 

Not sure why its not loading 

 

 

 

image.thumb.png.1ee4391d61c2d21510db00a58f650317.png

 

image.thumb.png.d51b85be9270f2784f9b52de9426acf9.png

 

image.thumb.png.1b2931082451e19c562e77e3ce554e95.png

image.png

Edited by OsoPolar

@OsoPolaris your dbhost correct? It's the same you habe in your redis.

 

Is the webui port your call correct? I am not sure but I think sge standard value is http://[IP]:[PORT:8000 for webui and yours in 8007

I have tried 8000 same issue happy to turn it back 

 

My redis is 6379

 

Postgres 5432

Edited by OsoPolar

docker run
  -d
  --name='paperless-ngx'
  --net='bearproxynet'
  -e TZ="Europe/London"
  -e HOST_OS="Unraid"
  -e HOST_HOSTNAME="Bearcave"
  -e HOST_CONTAINERNAME="paperless-ngx"
  -e 'PAPERLESS_REDIS'='redis://192.168.23.100:6379'
  -e 'PAPERLESS_OCR_LANGUAGE'='eng'
  -e 'PAPERLESS_OCR_LANGUAGES'='eng'
  -e 'PAPERLESS_FILENAME_FORMAT'='{created}-{correspondent}-{title}'
  -e 'PAPERLESS_TIME_ZONE'='Europe/London'
  -e 'PAPERLESS_DBHOST'='192.168.23.100'
  -e 'PAPERLESS_PORT'='5432'
  -e 'PAPERLESS_DBNAME'='paperless'
  -e 'PAPERLESS_DBUSER'='REDACTED'
  -e 'PAPERLESS_DBPASS'='REDACTED'
  -e 'PAPERLESS_IGNORE_DATES'=''
  -e 'PAPERLESS_CONSUMER_POLLING'='0'
  -e 'PAPERLESS_SECRET_KEY'='REDACTED'
  -e 'USERMAP_UID'='99'
  -e 'USERMAP_GID'='100'
  -l net.unraid.docker.managed=dockerman
  -l net.unraid.docker.webui='http://[IP]:[PORT:8000]'
  -l net.unraid.docker.icon='https://raw.githubusercontent.com/selfhosters/unRAID-CA-templates/master/templates/img/paperless.png'
  -p '8000:8007/tcp'
  -v '/mnt/user/appdata/paperless-ngx/data':'/usr/src/paperless/data':'rw'
  -v '/mnt/user/appdata/paperless-ngx/media':'/usr/src/paperless/media':'rw'
  -v '/mnt/user/appdata/paperless-ngx/consume':'/usr/src/paperless/consume':'rw'
  -v '/mnt/user/appdata/paperless-ngx/export':'/usr/src/paperless/export':'rw' 'ghcr.io/paperless-ngx/paperless-ngx'

REDACTED

Edited by OsoPolar

Postgres

 

docker run
  -d
  --name='postgresql14'
  --net='bearproxynet'
  -e TZ="Europe/London"
  -e HOST_OS="Unraid"
  -e HOST_HOSTNAME="Bearcave"
  -e HOST_CONTAINERNAME="postgresql14"
  -e 'POSTGRES_PASSWORD'='REDACTED'
  -e 'POSTGRES_USER'='REDACTED'
  -e 'POSTGRES_DB'='paperless'
  -l net.unraid.docker.managed=dockerman
  -l net.unraid.docker.icon='https://github.com/juusujanar/unraid-templates/raw/master/img/PostgreSQL-logo.png'
  -p '5432:5432/tcp'
  -v '/mnt/cache_nvme/appdata/postgresql14':'/var/lib/postgresql/data':'rw' 'postgres:14'

REDACTED

The command finished successfully!

  • 9 months later...

I hope I am posting to the correct place. I have a question on the consume folder. I have paperless-ngx up and running and it is working great. I have been adding files by drag-and-drop in the web interface. However, I would also like to drop files into the consume folder directly.

 

When I first setup paperless-ngx, I followed Flemming's blog. This means that the consume folder is a subfolder under the paperless-ngx_data share. However, I don't want to give permissions to that share. I want to create a specific consume share and give write permissions to that. Then paperless will consume the documents and move them into a folder that the average user doesn't have write permissions. Does that make sense? I created a new "consume" share, but I wasn't able to point paperless-ngx to that location.

 

And as you can tell, I am a novice at this.

 

TIA.

Is there not an environment variable which has the path to whatever folder it consumes from?

15 hours ago, mattie112 said:

Is there not an environment variable which has the path to whatever folder it consumes from?

I don't know what I did wrong before, but I changed it now and it appears to work. User error (as always).

 

Thanks!

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.