From ce8f31574759a5d3d6fc2eb32de083739069f406 Mon Sep 17 00:00:00 2001 From: Alex Povel <48824213+alexpovel@users.noreply.github.com> Date: Fri, 9 Apr 2021 22:14:09 +0200 Subject: [PATCH 1/3] Fix typo See also https://github.com/jonaswinkler/paperless-ng/blob/a3c4e4c6b65086f9c1af9569b9a771ef8320d917/docker/compose/docker-compose.env#L30 --- install-paperless-ng.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/install-paperless-ng.sh b/install-paperless-ng.sh index 39541dcc3..a31c9203f 100755 --- a/install-paperless-ng.sh +++ b/install-paperless-ng.sh @@ -291,7 +291,7 @@ DEFAULT_LANGUAGES="deu eng fra ita spa" if [[ ! $USERMAP_GID == "1000" ]] ; then echo "USERMAP_GID=$USERMAP_GID" fi - echo "PAPERLESS_ZIME_ZONE=$TIME_ZONE" + echo "PAPERLESS_TIME_ZONE=$TIME_ZONE" echo "PAPERLESS_OCR_LANGUAGE=$OCR_LANGUAGE" echo "PAPERLESS_SECRET_KEY=$SECRET_KEY" if [[ ! " ${DEFAULT_LANGUAGES[@]} " =~ " ${OCR_LANGUAGE} " ]] ; then From 31f5e178b3a8ed7eddefdaea80a174aea9a0dcb3 Mon Sep 17 00:00:00 2001 From: Lukasz Knop Date: Sun, 11 Apr 2021 15:16:04 +0200 Subject: [PATCH 2/3] add single compose file for usage in portainer environments --- docker/compose/docker-compose.portainer.yml | 77 +++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 docker/compose/docker-compose.portainer.yml diff --git a/docker/compose/docker-compose.portainer.yml b/docker/compose/docker-compose.portainer.yml new file mode 100644 index 000000000..e2f299f5d --- /dev/null +++ b/docker/compose/docker-compose.portainer.yml @@ -0,0 +1,77 @@ +# 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 + PAPERLESS_OCR_LANGUAGES: tur ces + PAPERLESS_SECRET_KEY: change-me + PAPERLESS_TIME_ZONE: America/Los_Angeles + PAPERLESS_OCR_LANGUAGE: eng + USERMAP_UID: 1000 + USERMAP_GID: 100 +volumes: + data: + media: + pgdata: From 2eac8fa91c4e7cfab2d9f0ed8c9532bb0ae72d0a Mon Sep 17 00:00:00 2001 From: Lukasz Knop Date: Sun, 11 Apr 2021 21:48:50 +0200 Subject: [PATCH 3/3] disabled unnecessary overrides, copied variable comments --- docker/compose/docker-compose.portainer.yml | 25 +++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/docker/compose/docker-compose.portainer.yml b/docker/compose/docker-compose.portainer.yml index e2f299f5d..12988c636 100644 --- a/docker/compose/docker-compose.portainer.yml +++ b/docker/compose/docker-compose.portainer.yml @@ -65,12 +65,29 @@ services: environment: PAPERLESS_REDIS: redis://broker:6379 PAPERLESS_DBHOST: db - PAPERLESS_OCR_LANGUAGES: tur ces - PAPERLESS_SECRET_KEY: change-me - PAPERLESS_TIME_ZONE: America/Los_Angeles - PAPERLESS_OCR_LANGUAGE: eng +# 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: change-me +# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC. + #PAPERLESS_TIME_ZONE: America/Los_Angeles +# The default language to use for OCR. Set this to the language most of your +# documents are written in. + #PAPERLESS_OCR_LANGUAGE: eng + volumes: data: media: