diff --git a/docker/paperless-ngx/.env b/docker/paperless-ngx/.env new file mode 100644 index 0000000..0bd5be6 --- /dev/null +++ b/docker/paperless-ngx/.env @@ -0,0 +1 @@ +COMPOSE_PROJECT_NAME=paperless diff --git a/docker/paperless-ngx/README.md b/docker/paperless-ngx/README.md new file mode 100644 index 0000000..2f03645 --- /dev/null +++ b/docker/paperless-ngx/README.md @@ -0,0 +1,16 @@ +# Paperless-ngx Docker container + +## TL;DR + +```sh +docker compose pull +docker compose run --rm webserver createsuperuser +docker compose up -d +open 'http://localhost:8000' +``` + +## Sources + +- [Installation] + +[installation]: https://docs.paperless-ngx.com/setup/#docker_hub diff --git a/docker/paperless-ngx/consume/.gitkeep b/docker/paperless-ngx/consume/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docker/paperless-ngx/docker-compose.env b/docker/paperless-ngx/docker-compose.env new file mode 100644 index 0000000..c4dbb4c --- /dev/null +++ b/docker/paperless-ngx/docker-compose.env @@ -0,0 +1,42 @@ +# 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=1000 + +# 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 + +############################################################################### +# Paperless-specific settings # +############################################################################### + +# All settings defined in the paperless.conf.example can be used here. The +# Docker setup does not use the configuration file. +# A few commonly adjusted settings are provided below. + +# This is required if you will be exposing Paperless-ngx on a public domain +# (if doing so please consider security measures such as reverse proxy) +#PAPERLESS_URL=https://paperless.example.com + +# 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 + +# Set if accessing paperless via a domain subpath e.g. https://domain.com/PATHPREFIX and using a reverse-proxy like traefik or nginx +#PAPERLESS_FORCE_SCRIPT_NAME=/PATHPREFIX +#PAPERLESS_STATIC_URL=/PATHPREFIX/static/ # trailing slash required diff --git a/docker/paperless-ngx/docker-compose.yaml b/docker/paperless-ngx/docker-compose.yaml new file mode 100644 index 0000000..32e381f --- /dev/null +++ b/docker/paperless-ngx/docker-compose.yaml @@ -0,0 +1,31 @@ +--- +# source: https://github.com/paperless-ngx/paperless-ngx/blob/main/docker/compose/docker-compose.sqlite.yml + +version: "3.4" +services: + broker: + image: docker.io/library/redis:7 + restart: unless-stopped + volumes: + - redisdata:/data + + webserver: + image: ghcr.io/paperless-ngx/paperless-ngx:latest + restart: unless-stopped + depends_on: + - broker + ports: + - "8000:8000" + volumes: + - data:/usr/src/paperless/data + - media:/usr/src/paperless/media + - ${PWD}/export:/usr/src/paperless/export + - ${PWD}/consume:/usr/src/paperless/consume + env_file: docker-compose.env + environment: + PAPERLESS_REDIS: redis://broker:6379 + +volumes: + data: + media: + redisdata: diff --git a/docker/paperless-ngx/export/.gitkeep b/docker/paperless-ngx/export/.gitkeep new file mode 100644 index 0000000..e69de29