Setting Up Paperless-NG with Portainer

ChrisBuzz · 22. Februar 2022

Hello,

unfortunately I am not very into using Dockers and this is the reason I need some support installing Paperless-NG with Portier.

I tried to install it with the following modified compose file: paperless-ng/docker/compose/docker-compose.portainer.yml

My file for the stack had the following input:

Spoiler anzeigen

Code

# docker-compose file for running paperless from the Docker Hub.
# This file contains everything paperless needs to run.
# Paperless supports amd64, arm and arm64 hardware.
#
# All compose files of paperless configure paperless in the following way:
#
# - Paperless is (re)started on system boot, if it was running before shutdown.
# - Docker volumes for storing data are managed by Docker.
# - Folders for importing and exporting files are created in the same directory
#   as this file and mounted to the correct folders inside the container.
# - Paperless listens on port 8010.
#
# In addition to that, this docker-compose file adds the following optional
# configurations:
#
# - Instead of SQLite (default), PostgreSQL is used as the database server.
#
# To install and update paperless with this file, do the following:
#
# - Open portainer Stacks list and click 'Add stack'
# - Paste the contents of this file and assign a name, e.g. 'Paperless'
# - Click 'Deploy the stack' and wait for it to be deployed
# - Open the list of containers, select paperless_webserver_1
# - Click 'Console' and then 'Connect' to open the command line inside the container
# - Run 'python3 manage.py createsuperuser' to create a user
# - Exit the console
#
# For more extensive installation and update instructions, refer to the
# documentation.

version: "3.4"
services:
  broker:
    image: redis:6.0
    restart: unless-stopped

  db:
    image: postgres:13
    restart: unless-stopped
    volumes:
      - pgdata:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: paperless
      POSTGRES_USER: paperless
      POSTGRES_PASSWORD: paperless

  webserver:
    image: jonaswinkler/paperless-ng:latest
    restart: unless-stopped
    depends_on:
      - db
      - broker
    ports:
      - 8010:8000
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000"]
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - data:/usr/src/paperless/data
      - media:/usr/src/paperless/media
      - ./export:/usr/src/paperless/export
      - ./consume:/usr/src/paperless/consume
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBHOST: db
# The UID and GID of the user used to run paperless in the container. Set this
# to your UID and GID on the host so that you have write access to the
# consumption directory.
      USERMAP_UID: 1000
      USERMAP_GID: 100
# Additional languages to install for text recognition, separated by a
# whitespace. Note that this is
# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
# language used for OCR.
# The container installs English, German, Italian, Spanish and French by
# default.
# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
# for available languages.
      #PAPERLESS_OCR_LANGUAGES: tur ces
# Adjust this key if you plan to make paperless available publicly. It should
# be a very long sequence of random characters. You don't need to remember it.
      #PAPERLESS_SECRET_KEY: jklqjdiejklqjdioekijde
# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
      #PAPERLESS_TIME_ZONE: Germany/Berlin
# The default language to use for OCR. Set this to the language most of your
# documents are written in.
      #PAPERLESS_OCR_LANGUAGE: ger

volumes:
  data:
  media:
  pgdata:

Alles anzeigen

Unfortunately after the stack is deployed it shows me that the container is running but unhealthy in Portainer. I can't get access to the console, too.

Is there anything I have to change?

Would be great to get some support over here and get this Docker to work in OMV. Maybe there is even an easier was as with Portainer.

Thanks,

Chris

Zoki · 22. Februar 2022

If you use this file as stack in portainer, you have to change the local volume definition or the files will end up inside the portainer_data volume somewhere:

Code

  volumes:
      - ./export:/usr/src/paperless/export     # change here
      - ./consume:/usr/src/paperless/consume   # change here

and the other definitions use named docker volumes. Make up your mind, if you want that.

What you need to put for the volumes depends how you set up docker on omv and where you want your data to live.

Which one of the containers is not working? In the stack there are three: broker, db and webserver and why can't you look into the logs?

Soma · 22. Februar 2022

For testing purposes, can you try this instead:

Papermerge seems to do the same and it's more actively maintained:

ciur/papermerge: Open Source Document Management System for Digital Archives (Scanned Documents) (github.com)

Login via ssh

mkdir papermerge

cd papermerge

nano docker-compose.yml

Copy/Paste the below code editing both instances of :

Code

      - POSTGRES_USER=dbuser # Edit this to your liking
      - POSTGRES_PASSWORD=dbpass # Ditto
      - POSTGRES_DB=dbname #Double Ditto

The 2 instances need to match each other:

Code

version: '3.7'
services:
  app:
    image: eugenci/papermerge:2.0.0
    container_name: papermerge_app
    ports:
      - "38000:8000"
    depends_on:
      - db
      - redis
    volumes:
      - media_root:/opt/media
    environment:
      - DJANGO_SETTINGS_MODULE=config.settings.production
      - POSTGRES_USER=dbuser
      - POSTGRES_PASSWORD=dbpass
      - POSTGRES_DB=dbname
      - POSTGRES_HOST=db
      - POSTGRES_PORT=5432
  db:
    image: postgres:12.3
    container_name: postgres_db
    volumes:
      - postgres_data:/var/lib/postgresql/data/
    environment:
      - POSTGRES_USER=dbuser
      - POSTGRES_PASSWORD=dbpass
      - POSTGRES_DB=dbname
  redis:
    container_name: 'redis'
    image: 'redis:6'
    ports:
      - '127.0.0.1:6379:6379'
    volumes:
      - 'redisdata:/data'
  worker:
    image: eugenci/papermerge-worker:v2.0.0
    container_name: papermerge_worker
    volumes:
      - media_root:/opt/media
    environment:
      - DJANGO_SETTINGS_MODULE=config.settings.production
      - POSTGRES_USER=dbuser
      - POSTGRES_PASSWORD=dbpass
      - POSTGRES_DB=dbname
      - POSTGRES_HOST=db
      - POSTGRES_PORT=5432      
volumes:
  postgres_data:
  media_root:
  redisdata:

Alles anzeigen

Save it and run:

docker-compose up -d

Access the webfront via http://LAN IP of HOST:38000 Changed to 38000 due to portainer already runs on port 8000

See if it works as expected.

ChrisBuzz · 22. Februar 2022

Zitat von Zoki
If you use this file as stack in portainer, you have to change the local volume definition or the files will end up inside the portainer_data volume somewhere:
Code
  volumes:
      - ./export:/usr/src/paperless/export     # change here
      - ./consume:/usr/src/paperless/consume   # change here
and the other definitions use named docker volumes. Make up your mind, if you want that.
What you need to put for the volumes depends how you set up docker on omv and where you want your data to live.

Which one of the containers is not working? In the stack there are three: broker, db and webserver and why can't you look into the logs?
Alles anzeigen

I changed the stack to the following:

Zitat

Code

# docker-compose file for running paperless from the Docker Hub.
# This file contains everything paperless needs to run.
# Paperless supports amd64, arm and arm64 hardware.
#
# All compose files of paperless configure paperless in the following way:
#
# - Paperless is (re)started on system boot, if it was running before shutdown.
# - Docker volumes for storing data are managed by Docker.
# - Folders for importing and exporting files are created in the same directory
#   as this file and mounted to the correct folders inside the container.
# - Paperless listens on port 8010.
#
# In addition to that, this docker-compose file adds the following optional
# configurations:
#
# - Instead of SQLite (default), PostgreSQL is used as the database server.
#
# To install and update paperless with this file, do the following:
#
# - Open portainer Stacks list and click 'Add stack'
# - Paste the contents of this file and assign a name, e.g. 'Paperless'
# - Click 'Deploy the stack' and wait for it to be deployed
# - Open the list of containers, select paperless_webserver_1
# - Click 'Console' and then 'Connect' to open the command line inside the container
# - Run 'python3 manage.py createsuperuser' to create a user
# - Exit the console
#
# For more extensive installation and update instructions, refer to the
# documentation.

version: "3.4"
services:
  broker:
    image: redis:6.0
    restart: unless-stopped

  db:
    image: postgres:13
    restart: unless-stopped
    volumes:
      - pgdata:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: paperless
      POSTGRES_USER: paperless
      POSTGRES_PASSWORD: paperless

  webserver:
    image: jonaswinkler/paperless-ng:latest
    restart: unless-stopped
    depends_on:
      - db
      - broker
    ports:
      - 38010:8000
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000"]
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - data:/usr/src/paperless/data
      - media:/usr/src/paperless/media
      - ./export:/srv/dev-disk-by-label-Backupintern/Backupintern/Eigene Dateien/Christoph/50 Dokumente/export
      - ./consume:/srv/dev-disk-by-label-Backupintern/Backupintern/Eigene Dateien/Christoph/50 Dokumente/consume
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBHOST: db
# The UID and GID of the user used to run paperless in the container. Set this
# to your UID and GID on the host so that you have write access to the
# consumption directory.
      USERMAP_UID: 1000
      USERMAP_GID: 100
# Additional languages to install for text recognition, separated by a
# whitespace. Note that this is
# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
# language used for OCR.
# The container installs English, German, Italian, Spanish and French by
# default.
# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
# for available languages.
      #PAPERLESS_OCR_LANGUAGES: tur ces
# Adjust this key if you plan to make paperless available publicly. It should
# be a very long sequence of random characters. You don't need to remember it.
      #PAPERLESS_SECRET_KEY: zuiewoouifhkjdshfuihwfjkbfhwj
# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
      #PAPERLESS_TIME_ZONE: Europe/Amsterdam
# The default language to use for OCR. Set this to the language most of your
# documents are written in.
      #PAPERLESS_OCR_LANGUAGE: ger

volumes:
  data:
  media:
  pgdata:

Alles anzeigen

Does this one look correct?

The container "webserver" is shown as unhealthy in Portainer.

There is also no IP adress & publish ports for this container available?

Don't know what else I can do?!

Soma: Thanks for your help. Already thought about using Papermerge but it seems Paperless has some advantages compared to Merge.

Soma · 22. Februar 2022

Your volumes are still wrong:

If you want to use this drive,

Code

/srv/dev-disk-by-label-Backupintern/

Login with user who has ID 1000 (as you marked it on the YML)

mkdir /srv/dev-disk-by-label-Backupintern/paperless_vol

This is how your YML/stack should be:

Code

version: "3.4"
services:
  broker:
    image: redis:6.0
    restart: unless-stopped

  db:
    image: postgres:13
    restart: unless-stopped
    volumes:
      - /srv/dev-disk-by-label-Backupintern/paperless_vol/pgdata:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: paperless
      POSTGRES_USER: paperless
      POSTGRES_PASSWORD: paperless

  webserver:
    image: jonaswinkler/paperless-ng:latest
    restart: unless-stopped
    depends_on:
      - db
      - broker
    ports:
      - 38010:8000
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000"]
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - /srv/dev-disk-by-label-Backupintern/paperless_vol/data:/usr/src/paperless/data
      - /srv/dev-disk-by-label-Backupintern/paperless_vol/media:/usr/src/paperless/media
      - /srv/dev-disk-by-label-Backupintern/paperless_vol/export:/usr/src/paperless/export
      - /srv/dev-disk-by-label-Backupintern/paperless_vol/consume:/usr/src/paperless/consume
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBHOST: db
      USERMAP_UID: 1000
      USERMAP_GID: 100
      #PAPERLESS_OCR_LANGUAGES: tur ces
# Adjust this key if you plan to make paperless available publicly. It should
# be a very long sequence of random characters. You don't need to remember it.
      #PAPERLESS_SECRET_KEY: zuiewoouifhkjdshfuihwfjkbfhwj
      PAPERLESS_TIME_ZONE: Europe/Amsterdam
# The default language to use for OCR. Set this to the language most of your
# documents are written in.
      #PAPERLESS_OCR_LANGUAGE: ger

Alles anzeigen

ChrisBuzz · 22. Februar 2022

Thanks!

I now changed it to the following:

Spoiler anzeigen

But I still have the issue that the container isn't working.

Any further ideas?

Zoki · 22. Februar 2022

"Isn't working" is not much of a description of your problem.

Which containers are runningß
How do you see there is a problem?
Post the logs

Or buy me a new cystal ball.

Soma · 22. Februar 2022

Ok, just did this on a fresh OMV6 install and it runs on 1st attempt:

YML/stack pasted into Portainer STACK creator:

Code

version: "3.4"
services:
  broker:
    image: redis:6.0
    restart: unless-stopped
  db:
    image: postgres:13
    restart: unless-stopped
    volumes:
      - /home/pi/paperless-ng/pgdata:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: paperless
      POSTGRES_USER: paperless
      POSTGRES_PASSWORD: paperless

  webserver:
    image: jonaswinkler/paperless-ng:latest
    restart: unless-stopped
    depends_on:
      - db
      - broker
    ports:
      - 8010:8000
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000"]
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - /home/pi/paperless-ng/data:/usr/src/paperless/data
      - /home/pi/paperless-ng/media:/usr/src/paperless/media
      - /home/pi/paperless-ng/export:/usr/src/paperless/export
      - /home/pi/paperless-ng/consume:/usr/src/paperless/consume
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBHOST: db
      USERMAP_UID: 1000
      USERMAP_GID: 100
      #PAPERLESS_OCR_LANGUAGES: tur ces
# Adjust this key if you plan to make paperless available publicly. It should
# be a very long sequence of random characters. You don't need to remember it.
      #PAPERLESS_SECRET_KEY: zuiewoouifhkjdshfuihwfjkbfhwj
      PAPERLESS_TIME_ZONE: Europe/Amsterdam
# The default language to use for OCR. Set this to the language most of your
# documents are written in.
      #PAPERLESS_OCR_LANGUAGE: ger

Alles anzeigen

Went to the Container paperless_webserver_1 and created the super user as instructed on the original docker-compose.yml via Exec Console (Symbol >_ on Portainer)

Accessed the web-front with:

http://LAN_IP:8010

user=papertest and the password created.

presto:

ChrisBuzz · 22. Februar 2022

Zitat von Zoki

"Isn't working" is not much of a description of your problem.

Which containers are runningß
How do you see there is a problem?
Post the logs

Or buy me a new cystal ball.

So after the stack is deployed I have the following 3 containers:

-paperless_webserver_1

-paperless_db_1

-paperless_broker_1

After trying to run the console in the webserver I receive the error message:

"Failure

Container 92d3589638dddc10aa91b3de549abcf6359bbe4c0fa0db3efa04f9bd109abfe6 is restarting, wait until the container is running"

Also the container is shown as not healthy and there is no ip or ports shown.

Logs are shown the following:

Spoiler anzeigen

Code

Current thread 0xb6fa2010 (most recent call first):
<no Python frame>
Executing /usr/local/bin/supervisord -c /etc/supervisord.conf
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f72010 (most recent call first):
<no Python frame>
Paperless-ng docker container starting...
Creating directory /tmp/paperless
Adjusting permissions of paperless files. This may take a while.
Waiting for PostgreSQL to start...
Apply database migrations...
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f13010 (most recent call first):
<no Python frame>
Executing /usr/local/bin/supervisord -c /etc/supervisord.conf
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f82010 (most recent call first):
<no Python frame>
Paperless-ng docker container starting...
Creating directory /tmp/paperless
Adjusting permissions of paperless files. This may take a while.
Waiting for PostgreSQL to start...
Apply database migrations...
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f15010 (most recent call first):
<no Python frame>
Executing /usr/local/bin/supervisord -c /etc/supervisord.conf
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f54010 (most recent call first):
<no Python frame>
Paperless-ng docker container starting...
Creating directory /tmp/paperless
Adjusting permissions of paperless files. This may take a while.
Waiting for PostgreSQL to start...
Apply database migrations...
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f1b010 (most recent call first):
<no Python frame>
Executing /usr/local/bin/supervisord -c /etc/supervisord.conf
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6fdc010 (most recent call first):
<no Python frame>
Paperless-ng docker container starting...
Creating directory /tmp/paperless
Adjusting permissions of paperless files. This may take a while.
Waiting for PostgreSQL to start...
Apply database migrations...
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6fd6010 (most recent call first):
<no Python frame>
Executing /usr/local/bin/supervisord -c /etc/supervisord.conf
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6ef9010 (most recent call first):
<no Python frame>
Paperless-ng docker container starting...
Creating directory /tmp/paperless
Adjusting permissions of paperless files. This may take a while.
Waiting for PostgreSQL to start...
Apply database migrations...
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f01010 (most recent call first):
<no Python frame>
Executing /usr/local/bin/supervisord -c /etc/supervisord.conf
Fatal Python error: init_interp_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted

Current thread 0xb6f33010 (most recent call first):
<no Python frame>

Alles anzeigen

Maybe I have to switch to OMV 6 with a fresh install

Soma · 22. Februar 2022

Zitat von ChrisBuzz

Maybe I have to switch to OMV 6 with a fresh install

Docker containers aren't bound to the Debian version, the YML should have the necessary apps to run in.

Let me try to set it on a OMV5 VM I have here to see what happens.

Zoki · 22. Februar 2022

If you google for the error, you will find it is related to an old ibseccomp2

and here is the tutorial: https://docs.linuxserver.io/fa…ntu-focal-and-alpine-3-13

ChrisBuzz · 22. Februar 2022

Zitat von Zoki

If you google for the error, you will find it is related to an old ibseccomp2
and here is the tutorial: https://docs.linuxserver.io/fa…ntu-focal-and-alpine-3-13

OMG...thanks, now it works!

You made my day. Sorry for being such a newb.

Setting Up Paperless-NG with Portainer

ChrisBuzz 25. Februar 2022

Jetzt mitmachen!

Tags