cleaned up and updated paperless

2026-09-03 18:36:22 +00:00 · 2026-04-22 22:42:57 +00:00
parent 0e8ad8cb51
commit f1558ddbaa
3 changed files with 30 additions and 7 deletions
@@ -0,0 +1,42 @@
+# Paperless
+
+## Project Details
+
+-   **Project Repository:** [Link](https://github.com/paperless-ngx/paperless-ngx)
+-   **Container Image:** [Github](https://github.com/paperless-ngx/paperless-ngx)
+-   **Compose Example:** [Compose](https://github.com/paperless-ngx/paperless-ngx/blob/main/docker/compose/docker-compose.mariadb-tika.yml)
+-   **Documentation:** [Docs](https://docs.paperless-ngx.com/)
+-   **Reverse Proxy Port:** `8000`
+
+## First Run
+
+It takes a very long time for the first run to initilaze, v
+view the log to see when it's ready.
+
+The ui will now create the first user for you, but we used to have to run:
+
+```
+docker exec -it paperless-ngx bash
+python3 manage.py createsuperuser
+```
+
+## Configuration
+
+All settings are controlled via environment variables in your `.env` file. Key variables include:
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `PAPERLESS_IMAGE` | `ghcr.io/paperless-ngx/paperless-ngx:latest` | Paperless Docker image |
+| `PAPERLESS_MARIADB_HOST` | `paperless-db` | MariaDB host |
+| `PAPERLESS_MARIADB_DATABASE` | `paperless` | Database name |
+| `PAPERLESS_MARIADB_USER` | `paperless` | Database user |
+| `PAPERLESS_MARIADB_PASSWORD` | `paperless` | Database password |
+| `PAPERLESS_MARIADB_ROOT_PASSWORD` | `paperless` | MariaDB root password |
+| `PAPERLESS_SECRET_KEY` | `changeme` | Secret key for Paperless |
+| `PAPERLESS_OCR_LANGUAGE` | `eng` | OCR language for scanned documents |
+| `VOL_PATH` | `./data` | Base path for volume storage |
+| `TZ` | `America/Vancouver` | Timezone |
+
+You can adjust these values in your `.env` (drived from `sample.env`) file before starting the containers.  
+
+For the full list of available options, see the [Paperless-ngx configuration documentation](http://docs.paperless-ngx.com/configuration/).
@@ -0,0 +1,82 @@
+###############################################################################
+# Paperless-ngx
+# Modifed from: https://github.com/paperless-ngx/paperless-ngx/blob/main/docker/compose/docker-compose.mariadb-tika.yml
+###############################################################################
+
+services:
+
+  paperless-broker:
+    image: docker.io/library/redis:8
+    restart: unless-stopped
+    volumes:
+      - ${VOL_PATH}/paperless/redis:/data
+    networks:
+      - paperless
+
+  paperless-db:
+    image: docker.io/library/mariadb:12
+    restart: unless-stopped
+    volumes:
+      - ${VOL_PATH}/paperless/db:/var/lib/mysql
+    environment:
+      MARIADB_HOST: ${PAPERLESS_MARIADB_HOST:-paperless-db}
+      MARIADB_DATABASE: ${PAPERLESS_MARIADB_DATABASE:-paperless}
+      MARIADB_USER: ${PAPERLESS_MARIADB_USER:-paperless}
+      MARIADB_PASSWORD: ${PAPERLESS_MARIADB_PASSWORD:-paperless}
+      MARIADB_ROOT_PASSWORD: ${PAPERLESS_MARIADB_ROOT_PASSWORD:-paperless}
+    networks:
+      - paperless
+
+  paperless-webserver:
+    image: ${PAPERLESS_IMAGE:-ghcr.io/paperless-ngx/paperless-ngx:latest}
+    restart: unless-stopped
+    volumes:
+      - ${VOL_PATH}/paperless/data:/usr/src/paperless/data
+      - ${VOL_PATH}/paperless/media:/usr/src/paperless/media
+      - ${VOL_PATH}/paperless/export:/usr/src/paperless/export
+      - ${VOL_PATH}/paperless/consume:/usr/src/paperless/consume
+    environment:
+      PAPERLESS_REDIS: redis://paperless-broker:6379
+      PAPERLESS_DBENGINE: mariadb
+      PAPERLESS_DBHOST: paperless-db
+      PAPERLESS_DBUSER: ${PAPERLESS_MARIADB_USER:-paperless}
+      PAPERLESS_DBPASS: ${PAPERLESS_MARIADB_PASSWORD:-paperless}
+      PAPERLESS_DBPORT: 3306
+      PAPERLESS_TIKA_ENABLED: 1
+      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://paperless-gotenberg:3000
+      PAPERLESS_TIKA_ENDPOINT: http://paperless-tika:9998
+      PAPERLESS_TIME_ZONE: ${TZ:-America/Vancouver}
+      PAPERLESS_SECRET_KEY: ${PAPERLESS_SECRET_KEY:-changeme}
+      PAPERLESS_OCR_LANGUAGE: ${PAPERLESS_OCR_LANGUAGE:-eng}
+      PAPERLESS_URL: ${PAPERLESS_URL:-http://localhost}
+      PAPERLESS_CONSUMER_DELETE_DUPLICATES: ${PAPERLESS_CONSUMER_DELETE_DUPLICATES:-0}
+      PAPERLESS_CONSUMER_RECURSIVE: 1
+    ports:
+      - ${PAPERLESS_PORT:-8000}:8000
+    networks:
+      - paperless_internal
+      - proxy
+
+  paperless-gotenberg:
+    image: docker.io/gotenberg/gotenberg:8.25
+    restart: unless-stopped
+    # The gotenberg chromium route is used to convert .eml files. We do not
+    # want to allow external content like tracking pixels or even javascript.
+    command:
+      - "gotenberg"
+      - "--chromium-disable-javascript=true"
+      - "--chromium-allow-list=file:///tmp/.*"
+    networks:
+      - paperless
+
+  paperless-tika:
+    image: docker.io/apache/tika:latest
+    restart: unless-stopped
+    networks:
+      - paperless
+
+networks:
+  proxy:
+    external: true
+  paperless:
+    driver: bridge
@@ -0,0 +1,19 @@
+###############################################################################
+# Paperless-ngx settings                                                      #
+# See http://docs.paperless-ngx.com/configuration/ for all available options.
+###############################################################################
+
+TZ=America/Vancouver
+VOL_PATH=./data
+
+PAPERLESS_IMAGE=ghcr.io/paperless-ngx/paperless-ngx:latest
+PAPERLESS_MARIADB_HOST=paperless-db
+PAPERLESS_MARIADB_DATABASE=paperless
+PAPERLESS_MARIADB_USER=paperless
+PAPERLESS_MARIADB_PASSWORD=paperless
+PAPERLESS_MARIADB_ROOT_PASSWORD=paperless
+PAPERLESS_SECRET_KEY=changeme
+PAPERLESS_OCR_LANGUAGE=eng
+PAPERLESS_URL=http://localhost
+PAPERLESS_CONSUMER_DELETE_DUPLICATES=0
+PAPERLESS_PORT=8000