API tools faq
paste
Advertisement
kiwijunglist

paperless-ngx stack with local AI containers

kiwijunglist
Jun 22nd, 2025 (edited)
771
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
YAML 7.87 KB | None | 0 0
raw download clone embed print report
  1. #
  2. # DOCKER COMPOSE STACK FOR DOCKER COMPOSE MANAGER PLUGIN FOR UNRAID
  3. #
  4. #
  5. # 1 EDIT THIS COMPOSE FILE AND CHANGE THE DEFAULT PASSWORD FOR THE DATABASE (optional)
  6. #
  7. # Replace the 3 instances of "password123"
  8. #
  9. #
  10. # 2 CREATE THE EXPECTED DIRECTORIES IN APPDATA BEFORE CREATING THE CONTAINERS
  11. #
  12. # sudo mkdir -p /mnt/user/appdata/paperless/{consume,export,redis,mariadb,paperless-ai,ollama}
  13. # sudo mkdir -p /mnt/user/appdata/paperless/paperless/{data,media}
  14. # sudo mkdir -p /mnt/user/appdata/paperless/paperless-gpt/{prompts,hocr,pdf}
  15. # sudo chown 999:999 /mnt/user/appdata/paperless/mariadb
  16. #
  17. #
  18. # 3 YOU CAN CHECK THE PERMISSIONS FOR APPDATA ARE CORRECT WITH THE ls -l COMMAND
  19. #
  20. # ls -l /mnt/user/appdata/paperless
  21. #
  22. # drwxr-xr-x 1 root root    6 Jun 22 17:00 consume/
  23. # drwxr-xr-x 1 root root    6 Jun 22 17:00 export/
  24. # drwxr-xr-x 1  999  999 4096 Jun 22 17:01 mariadb/
  25. # drwxr-xr-x 1 root root   60 Jun 22 17:01 ollama/
  26. # drwxr-xr-x 1 root root   31 Jun 22 17:00 paperless/
  27. # drwxr-xr-x 1 root root  12      7 Jun 22 17:26 paperless-ai/
  28. # drwxr-xr-x 1 root root   44 Jun 22 17:00 paperless-gpt/
  29. # drwxr-xr-x 1 root root   22 Jun 22 18:26 redis/
  30. #
  31. #
  32. # 4. YOU CAN NOW CLICK DOCKER-COMPOSE UP AND START UP ALL THE COTNTAINERS
  33. #
  34. #
  35. # 5. AFTER RUNNING OLLAMA CONTAINER YOU NEED TO PULL THE AI MODELS
  36. #
  37. # docker exec -it paperless-ollama ollama pull llama3
  38. # docker exec -it paperless-ollama ollama pull minicpm-v
  39. #
  40. #
  41. # 6. PAPERLESS-NGX SETUP (WEB GUI)
  42. #
  43. # you need to generate an API key in paperless-ngx
  44. # Point your web-browser to paperless-ngx http://xxx.xxx.xxx.xxx:8000
  45. # Do the basic setup and then click edit my profile in top right had corner to generate a token
  46. #
  47. #
  48. # 7. PAPERLESS-AI SETUP (WEB GUI)
  49. #
  50. # Point your web-browser to paperless-ai http://xxx.xxx.xxx.xxx:3000
  51. # API Token = the token generated by paperless-ngx in step 6.
  52. # Ollama API URL = http://paperless-ollama:11434
  53. # Ollama model = llama3
  54. #
  55. # 8. PAPERLESS-GPT SETUP (EDIT docker-compose file)
  56. #
  57. # Edit this compose file and insert the API token you generated in step 6.
  58. #
  59. # Example:
  60. #
  61. #   paperless-gpt:
  62. #     container_name: paperless-gpt
  63. #     image: icereed/paperless-gpt:latest
  64. #     restart: unless-stopped
  65. #     environment:
  66. #       PAPERLESS_BASE_URL: "http://paperless:8000"
  67. #       PAPERLESS_API_TOKEN: e3087dd8e058aebfc522fb91426d48d8b4a53a72
  68. #
  69. #
  70. # EXTERNAL PORTS OPENED BY THIS DOCKER STACK
  71. #
  72. # 8000 = paperless-ngx
  73. # 3000 = paperless-ai
  74. # 8082 = paperless-gpt
  75. #
  76.  
  77.  
  78. services:
  80.   paperless:
  81.     container_name: paperless
  82.     image: ghcr.io/paperless-ngx/paperless-ngx:latest
  83.     restart: unless-stopped
  84.     depends_on:
  85.      - paperless-mariadb
  86.       - paperless-redis
  87.       - paperless-gotenberg
  88.       - paperless-tika
  89.     ports:
  90.      - "8000:8000"
  91.     volumes:
  92.      - /mnt/user/appdata/paperless/paperless/data:/usr/src/paperless/data
  93.       - /mnt/user/appdata/paperless/paperless/media:/usr/src/paperless/media
  94.       # - /mnt/user/appdata/paperless/consume:/usr/src/paperless/consume
  95.       # - /mnt/user/appdata/paperless/export:/usr/src/paperless/export
  96.     environment:
  97.       USERMAP_UID: 99
  98.       USERMAP_GID: 100
  99.       PAPERLESS_REDIS: redis://paperless-redis:6379
  100.       PAPERLESS_DBENGINE: mariadb
  101.       PAPERLESS_DBHOST: paperless-mariadb
  102.       PAPERLESS_DBPORT: 3306
  103.       PAPERLESS_DBUSER: paperless
  104.       PAPERLESS_DBPASS: password123 # Password here
  105.       PAPERLESS_TIME_ZONE: Pacific/Auckland
  106.       PAPERLESS_OCR_LANGUAGE: eng
  107.       PAPERLESS_TIKA_ENABLED: 1
  108.       PAPERLESS_TIKA_ENDPOINT: http://paperless-tika:9998
  109.       PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://paperless-gotenberg:3000
  110.       PAPERLESS_TASK_WORKERS: 6
  111.       PAPERLESS_ENABLE_WEBSERVER: true
  112.       PAPERLESS_PRE_CONSUME_SCRIPT: ""
  113.       PAPERLESS_POST_CONSUME_SCRIPT: ""
  114.     labels:
  115.       net.unraid.docker.icon: "https://libs.websoft9.com/Websoft9/logo/product/paperlessngx-websoft9.png"
  116.       net.unraid.docker.webui: "http://[IP]:8000"
  117.     networks:
  118.      - paperless-net
  119.  
  120.  
  121.   paperless-redis:
  122.     container_name: paperless-redis
  123.     image: docker.io/library/redis:8
  124.     restart: unless-stopped
  125.     volumes:
  126.      - /mnt/user/appdata/paperless/redis:/data
  127.     cap_drop:
  128.      - ALL
  129.     security_opt:
  130.      - no-new-privileges=true
  131.     networks:
  132.      - paperless-net
  133.  
  134.  
  135.   paperless-mariadb:
  136.     container_name: paperless-mariadb
  137.     image: docker.io/library/mariadb:11
  138.     restart: unless-stopped
  139.     volumes:
  140.      - /mnt/user/appdata/paperless/mariadb:/var/lib/mysql
  141.     environment:
  142.       MARIADB_HOST: paperless
  143.       MARIADB_DATABASE: paperless
  144.       MARIADB_USER: paperless
  145.       MARIADB_PASSWORD: password123 # Password here
  146.       MARIADB_ROOT_PASSWORD: password123 # Password here
  147.     networks:
  148.      - paperless-net
  149.  
  150.  
  151.   paperless-gotenberg:
  152.     container_name: paperless-gotenberg
  153.     image: docker.io/gotenberg/gotenberg:8.20
  154.     restart: unless-stopped
  155.     command:
  156.      - "gotenberg"
  157.       - "--chromium-disable-javascript=true"
  158.       - "--chromium-allow-list=file:///tmp/.*"
  159.     cap_drop:
  160.      - ALL
  161.     security_opt:
  162.      - no-new-privileges=true
  163.     networks:
  164.      - paperless-net
  165.  
  166.  
  167.   paperless-tika:
  168.     container_name: paperless-tika
  169.     image: docker.io/apache/tika:latest
  170.     restart: unless-stopped
  171.     cap_drop:
  172.      - ALL
  173.     networks:
  174.      - paperless-net
  175.  
  176.  
  177.   paperless-ai:
  178.     container_name: paperless-ai
  179.     image: clusterzx/paperless-ai
  180.     restart: unless-stopped
  181.     environment:
  182.      - PAPERLESS_AI_PORT=3000
  183.       - RAG_SERVICE_URL=http://paperless:8000
  184.       - RAG_SERVICE_ENABLED=true
  185.     ports:
  186.      - "3000:3000"
  187.     volumes:
  188.      - /mnt/user/appdata/paperless/paperless-ai:/app/data
  189.     cap_drop:
  190.      - ALL
  191.     security_opt:
  192.      - no-new-privileges=true
  193.     labels:
  194.       net.unraid.docker.webui: "http://[IP]:3000"
  195.     networks:
  196.      - paperless-net
  197.  
  198.  
  199.   paperless-gpt:
  200.     container_name: paperless-gpt
  201.     image: icereed/paperless-gpt:latest
  202.     restart: unless-stopped
  203.     environment:
  204.       PAPERLESS_BASE_URL: "http://paperless:8000"
  205.       PAPERLESS_API_TOKEN: e3087dd8e058aebfc522fb91426d48d8b4a53a72 # API TOKEN FROM PAPERLESS-NGX GOES HERE
  206.       LLM_PROVIDER: "ollama"
  207.       LLM_MODEL: "llama3"
  208.       OLLAMA_HOST: "http://paperless-ollama:11434"
  209.       TOKEN_LIMIT: 1000
  210.       OCR_PROVIDER: "llm"
  211.       VISION_LLM_PROVIDER: "ollama"
  212.       VISION_LLM_MODEL: "minicpm-v"
  213.       OCR_PROCESS_MODE: "image"
  214.       PDF_SKIP_EXISTING_OCR: "false"
  215.       CREATE_LOCAL_HOCR: "false"
  216.       LOCAL_HOCR_PATH: "/app/hocr"
  217.       CREATE_LOCAL_PDF: "false"
  218.       LOCAL_PDF_PATH: "/app/pdf"
  219.       PDF_UPLOAD: "false"
  220.       PDF_REPLACE: "false"
  221.       PDF_COPY_METADATA: "true"
  222.       PDF_OCR_TAGGING: "true"
  223.       OCR_LIMIT_PAGES: "0"
  224.       LOG_LEVEL: "info"
  225.       MANUAL_TAG: "paperless-gpt"
  226.       AUTO_TAG: "paperless-gpt-auto"
  227.       AUTO_OCR_TAG: "paperless-gpt-ocr-auto"
  228.       PDF_OCR_COMPLETE_TAG: "paperless-gpt-ocr-complete"
  229.       AUTO_GENERATE_TAGS: "true"
  230.       AUTO_GENERATE_TITLE: "true"
  231.     volumes:
  232.      - /mnt/user/appdata/paperless/paperless-gpt/prompts:/app/prompts
  233.       - /mnt/user/appdata/paperless/paperless-gpt/hocr:/app/hocr
  234.       - /mnt/user/appdata/paperless/paperless-gpt/pdf:/app/pdf
  235.       # - ${HOME}/.config/gcloud/application_default_credentials.json:/app/credentials.json
  236.     ports:
  237.      - "8082:8080"
  238.     depends_on:
  239.      - paperless
  240.     cap_drop:
  241.      - ALL
  242.     security_opt:
  243.      - no-new-privileges=true
  244.     labels:
  245.       net.unraid.docker.webui: "http://[IP]:8082"
  246.     networks:
  247.      - paperless-net
  248.  
  249.  
  250.   paperless-ollama:
  251.     container_name: paperless-ollama
  252.     image: ollama/ollama
  253.     restart: unless-stopped
  254.     volumes:
  255.      - /mnt/user/appdata/paperless/ollama:/root/.ollama      
  256.     cap_drop:
  257.      - ALL
  258.     security_opt:
  259.      - no-new-privileges=true
  260.     networks:
  261.      - paperless-net
  262.  
  263. networks:
  264.   paperless-net:
  265.     driver: bridge
  266.  
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!