initial commit

README.md

@@ -0,0 +1,17 @@
+Paperless-ngx is a document archive that indexes each document and uses AI to tag, name, and classify the document type.  This archive is easily searchable for any document.
+# Installation
+
+Official documentation can be found here - https://docs.paperless-ngx.com/setup/
+
+1. **Insert instructions on creating a stack in portainer here.**
+2. Name the stack paperless-ngx
+3. Use the following docker compose YAML
+4. Open the list of containers, select paperless_webserver_1
+5. Click 'Console' and then 'Connect' to open the command line inside the container
+6. Run `python3 manage.py createsuperuser` to create a user
+7. Exit the console
+
+# Backup
+
+
+# Restore

docker-compose.yaml

@@ -0,0 +1,94 @@
+# 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: docker.io/library/redis:7
+    restart: unless-stopped
+    volumes:
+      - /home/mattspeer/paperless-ngx/redis/redisdata:/data
+
+  db:
+    image: docker.io/library/postgres:15
+    restart: unless-stopped
+    volumes:
+      - /home/mattspeer/paperless-ngx/postgress/pgdata:/var/lib/postgresql/data
+    environment:
+      POSTGRES_DB: paperless
+      POSTGRES_USER: paperless
+      POSTGRES_PASSWORD: paperless
+
+  webserver:
+    image: ghcr.io/paperless-ngx/paperless-ngx:latest
+    restart: unless-stopped
+    depends_on:
+      - db
+      - broker
+    ports:
+      - "8010:8000"
+    volumes:
+      - /home/mattspeer/paperless-ngx/web/data:/usr/src/paperless/data
+      - /doc-archive/artifacts:/usr/src/paperless/media
+      - /doc-archive/export:/usr/src/paperless/export
+      - /doc-archive/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: 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
+# 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: f87r3q8urqdasoiW98R32RIFDSAWO87OIJEWOIJFA893QOIJ3298EF98EWOIJEW84398R3
+# 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
+# The url used to access paperless
+      PAPERLESS_URL: https://paperless.speerfam.net
+
+volumes:
+  data:
+  media:
+  pgdata:
+  redisdata: