Paperless-ngx

קבצים מוכנים להפעלה

רמת תמיכה נתמך

תבנית Compose מהמקורות הרשמיים; עוד לא נבדקה בהרצה.

צור docker-compose

אפשרויות שמשנות משאבים

office-documents

מסמכי Office ומיילים: מוסיף את Apache Tika (חילוץ טקסט) ואת Gotenberg (המרה ל-PDF), כמו בקובץ ה-Compose הרשמי עם tika, כך שאפשר לקלוט קובצי ‎.docx, ‏‎.xlsx, ‏‎.pptx, ‏‎.odt ו-‎.eml. בלעדיו Paperless מקבל רק PDF, תמונות וטקסט פשוט.

ברירת מחדל: כבוי

• כשהערך פעיל: Apache Tika (Office text extraction) +0.5 vCPU · +0.75 GiB RAM · +0.5 GiB דיסק [11][23][33]
• כשהערך פעיל: Gotenberg (Office and e-mail to PDF) +1 vCPU · +1 GiB RAM · +1.75 GiB דיסק [23][27][28][30]

שדרוג וחזרה לאחור

איך עוברים לגרסה חדשה בבטחה, ואיך חוזרים אחורה אם משהו נכשל.

קודם גיבוי

הריצו את document_exporter ל-volume של export, והעתיקו גם את ה-volumes של PostgreSQL, ‏data ו-media (או pg_dump ועוד שני ה-volumes): ייצוא אפשר לייבא רק לאותה גרסה של Paperless. [12]

שלבי השדרוג

1. קראו את ה-release notes של כל גרסה שאתם מדלגים עליה; כדי להגיע ל-v3 צריך להיות קודם על 2.20.15 ולעבור על מדריך המיגרציה ל-v3. [12][13]
2. חכו שאף מסמך לא נמצא בקליטה, קחו את הגיבוי, ואז docker compose down. [12]
3. הגדירו את ה-tag החדש המוצמד של ה-image, הריצו docker compose pull ואז docker compose up -d; ה-migrations של מסד הנתונים רצים כשהקונטיינר עולה. [12]נגזרהתיעוד משדרג עם pull ו-up על ה-tag ‏latest (או סדרה מוצמדת); עם גרסה מוצמדת משנים קודם את ה-tag.

חזרה לאחור

עצרו את ה-stack, שחזרו את ה-volumes של PostgreSQL, ‏data ו-media מלפני השדרוג, החזירו את ה-tag הישן והפעילו. ה-migrations לא מתבטלים אוטומטית, והייצוא מלפני השדרוג נכנס רק לגרסה הישנה. [12]נגזרהתיעוד לא נותן נוהל rollback; זה נובע מגיבוי ה-volumes שהוא מתאר ומהכלל שייצוא דורש את אותה גרסה.

שינויים שוברים ידועים

• בגרסה 3.0.0: ‏PAPERLESS_SECRET_KEY הוא חובה (אין ברירת מחדל מובנית), ומשתמשי PostgreSQL חייבים להגדיר PAPERLESS_DBENGINE=postgresql; משתני ה-SSL, ה-timeout וה-pool של ה-DB עברו ל-PAPERLESS_DB_OPTIONS. [13]
• בגרסה 3.0.0: הגדרות ה-OCR והארכיון הופרדו: ‏OCR_MODE skip ו-skip_noarchive ו-OCR_SKIP_ARCHIVE_FILE הוסרו (עכשיו OCR_MODE=auto ו-ARCHIVE_FILE_GENERATION), כפילויות כבר לא נדחות כברירת מחדל, והצפנת מסמכים הוסרה (פענחו לפני השדרוג). [13][15]
• בגרסה 3.0.0: החיפוש עבר מ-Whoosh ל-Tantivy והאינדקס נבנה מחדש בהפעלה הראשונה; חיפוש בהערות ובשדות מותאמים משתמש ב-notes.note: וב-custom_fields.value:. היסטוריית המשימות נמחקת, סקריפטים של consume מקבלים רק משתני סביבה, ומאחורי proxy ההתחברות עשויה לדרוש את הגדרות ה-trusted proxy כדי להימנע מ-403. [13]
• בגרסה 3.0.0: מעבדי x86-64 בלי SSE4.2 ‏(x86-64-v2) מפילים את ה-worker כשהמסווג נטען; בחומרה כזו הגדירו PAPERLESS_TRAIN_TASK_CRON=disable. [13]
• בגרסה 2.18.0: ‏PostgreSQL 14 היא הגרסה המינימלית הנתמכת. [12]

מגבלות

• ‏task worker אחד כברירת מחדל (PAPERLESS_TASK_WORKERS=1): מסמכים נקלטים אחד אחרי השני, ורק העמודים של מסמך אחד רצים במקביל (thread לכל ליבה). יותר workers דורשים יותר RAM, ומכפלת workers × threads לא צריכה לעבור את מספר הליבות. [11][19]
• בלי האפשרות office-documents נקלטים רק PDF, תמונות וטקסט פשוט; קובצי Word, ‏Excel, ‏PowerPoint, ‏LibreOffice ומיילים מסוג ‎.eml דורשים את Tika ואת Gotenberg. [11][14]
• ה-image מבצע OCR רק באנגלית, גרמנית, צרפתית, איטלקית וספרדית. עברית דורשת את האפשרות ocr-hebrew, שמתקינה את השפה בעלייה (נדרש אינטרנט, ולא אפשרי במצב rootless). [7][10][11]
• מאז v3, מעבדי x86-64 צריכים SSE4.2 ‏(x86-64-v2): במעבדים ישנים או חלשים המסווג מפיל את ה-worker, אלא אם מגדירים PAPERLESS_TRAIN_TASK_CRON=disable. [13]

אבטחה

• הגישו את Paperless ב-HTTPS דרך reverse proxy והגדירו את PAPERLESS_URL לכתובת הציבורית, מה שמגביל את ה-hosts המותרים ואת מקורות ה-CSRF. לעולם אל תשתמשו ב-PAPERLESS_AUTO_LOGIN_USERNAME ב-instance חשוף. [11]
• בלי PAPERLESS_ADMIN_USER המבקר הראשון מתבקש ליצור את ה-superuser, ו-superuser רואה את כל המסמכים. התבנית יוצרת אותו מ-.env בהפעלה הראשונה; לעבודה יומיומית השתמשו בחשבון רגיל. [10][11]
• הודעות המשימות ב-broker חתומות עם PAPERLESS_SECRET_KEY, ול-Valkey אין סיסמה, ולכן השאירו אותו ברשת הפנימית בלבד. ‏Gotenberg רץ בלי JavaScript ויכול לטעון רק קבצים מקומיים מ-/tmp, כך שמיילים לא יכולים למשוך tracking pixels או סקריפטים. [3][11][19]

גיבוי

• הריצו לפי לוח זמנים docker compose exec -T paperless-ngx document_exporter ../export: הוא כותב מסמכים, thumbnails ו-manifest של כל מסד הנתונים ל-volume של export ומעדכן אותו באופן אינקרמנטלי. העתיקו את ה-volume הזה מחוץ לשרת. טוקני API לא נכללים, וייצוא נכנס רק לאותה גרסה. [12]
• לשחזור מלא של אותה גרסה, גבו את ה-volume של media (המסמכים), את ה-volume של data (אינדקס, מסווג, הגדרות) ואת PostgreSQL ‏(pg_dump), כשאף מסמך לא נמצא בקליטה באותו זמן. [12][14]

גרסה אחרונה

הגרסה האחרונה של הפרויקט

Paperless-ngx 3.3.1 [21][22]

הפרופיל נבדק מול

Paperless-ngx 3.3.1

הפרופיל נבדק מול הגרסה האחרונה.

נבדק ב-

14 באוק׳ 2026

מצב

נבדק ב-90 הימים האחרונים

איפה הגרסאות מתפרסמות

תגיות ב-Docker Hub

הגרסאות האחרונות של כל האפליקציות

גרסה

סטטוס הפרופיל

פורסם

נבדק מול גרסה

Paperless-ngx 3.3.1

גרסת הפרופיל

1.0.0

המספרים אומתו

14 באוק׳ 2026

גרסת הקטלוג

2026.10.10

מדיניות sizing

2026.10.0

קובץ Compose

לא אומת

הפרויקט וחלופות

האתר הרשמי

docs.paperless-ngx.com

קוד מקור

github.com/paperless-ngx/paperless-ngx

חלופות

Mayan EDMSDocspell

מקורות

1. Docker Docs: Control startup order in Compose (pg_isready healthcheck, service_healthy) (תיעוד רשמי · נקרא 11 באוק׳ 2026)
2. paperless-ngx repository: docker/compose/docker-compose.postgres.yml at v3.3.1 (webserver 8000:8000, postgres:18, valkey/valkey:9-alpine, data/media volumes, ./export and ./consume) (Compose רשמי · נקרא 14 באוק׳ 2026)
3. paperless-ngx repository: docker/compose/docker-compose.postgres-tika.yml at v3.3.1 (adds gotenberg:8.37 with JavaScript disabled and apache/tika:3.3.1.0) (Compose רשמי · נקרא 14 באוק׳ 2026)
4. paperless-ngx repository: docker/compose/docker-compose.env at v3.3.1 (PAPERLESS_SECRET_KEY required; PAPERLESS_URL for a public domain; USERMAP_UID/GID 1000) (Compose רשמי · נקרא 14 באוק׳ 2026)
5. paperless-ngx repository: s6 svc-webserver run script at v3.3.1 (granian on port 8000, 1 worker, s6-setuidgid paperless) (מאגר רשמי · נקרא 14 באוק׳ 2026)
6. paperless-ngx repository: s6 init-folders run script at v3.3.1 (creates and chowns data, media, consume, export to paperless when started as root) (מאגר רשמי · נקרא 14 באוק׳ 2026)
7. paperless-ngx repository: s6 init-tesseract-langs run script at v3.3.1 (apt-get installs tesseract-ocr-<lang> for PAPERLESS_OCR_LANGUAGES at start, root only) (מאגר רשמי · נקרא 14 באוק׳ 2026)
8. Debian packages: tesseract-ocr-heb in trixie (Tesseract Hebrew language data) (מאגר רשמי · נקרא 14 באוק׳ 2026)
9. Gotenberg Docs: Health Check (GET /health, 200 when Chromium and LibreOffice are up) (תיעוד רשמי · נקרא 14 באוק׳ 2026)
10. Paperless-ngx docs (v3.3.1): Setup (Docker Compose install, PostgreSQL recommended, superuser prompt, rootless, less powerful devices) (תיעוד רשמי · נקרא 14 באוק׳ 2026)
11. Paperless-ngx docs (v3.3.1): Configuration (TASK_WORKERS 1, THREADS_PER_WORKER, WEBSERVER_WORKERS 1, SECRET_KEY required, ADMIN_USER, Tika, OCR languages) (תיעוד רשמי · נקרא 14 באוק׳ 2026)
12. Paperless-ngx docs (v3.3.1): Administration (backups, document_exporter/importer, updating with Docker, PostgreSQL 14 minimum) (תיעוד רשמי · נקרא 14 באוק׳ 2026)
13. Paperless-ngx docs (v3.3.1): v3 Migration Guide (from 2.20.15 only; SECRET_KEY and DBENGINE required; OCR settings; Tantivy index; x86-64-v2 CPUs) (Release notes · נקרא 14 באוק׳ 2026)
14. Paperless-ngx docs (v3.3.1): FAQ (documents in the media volume, supported file types, duplicates allowed, any Redis-compatible broker) (תיעוד רשמי · נקרא 14 באוק׳ 2026)
15. Paperless-ngx docs (v3.3.1): Changelog (3.3.0 back to 3.0.0 breaking changes) (Release notes · נקרא 14 באוק׳ 2026)
16. paperless-ngx repository: Dockerfile at v3.3.1 (user paperless 1000:1000, VOLUME data/media/consume/export, EXPOSE 8000, HEALTHCHECK curl localhost:8000 every 30 s) (מאגר רשמי · נקרא 14 באוק׳ 2026)
17. paperless-ngx repository: s6 init-superuser run script at v3.3.1 (manage_superuser when PAPERLESS_ADMIN_USER is set) (מאגר רשמי · נקרא 14 באוק׳ 2026)
18. paperless-ngx repository: s6 svc-worker run script at v3.3.1 (celery worker as user paperless) (מאגר רשמי · נקרא 14 באוק׳ 2026)
19. paperless-ngx repository: settings at v3.3.1 (CELERY_WORKER_CONCURRENCY = TASK_WORKERS default 1; threads = cpu_count / workers; task limit 1800 s; result TTL 3600 s; signed-pickle messages) (מאגר רשמי · נקרא 14 באוק׳ 2026)
20. paperless-ngx repository: LICENSE at v3.3.1 (GNU GPL v3) (מאגר רשמי · נקרא 14 באוק׳ 2026)
21. Docker Hub: paperlessngx/paperless-ngx tag 3.3.1 (same index digest as GHCR 3.3.1; linux/amd64 831,850,028 B compressed; layers decompressed and counted: 2,575,073,792 B) (מדידה · נקרא 14 באוק׳ 2026)
22. Docker Hub: paperlessngx/paperless-ngx tags (newest stable 3.3.1, 2026-10-12; latest and 3.3 point to it) (מאגר רשמי · נקרא 14 באוק׳ 2026)
23. Virtua.Cloud tutorial: Self-host Paperless-ngx on a VPS (v3; webserver ~650 MB idle / ~1,100 MB during OCR; Tika ~160/400 MB; Gotenberg ~10/300 MB; 5-10 GB per 1,000 documents) (קהילה · נקרא 14 באוק׳ 2026)
24. valkey-io/valkey-container: 9.1/alpine Dockerfile (9.1.2; user valkey uid 999 gid 1000; WORKDIR /data; EXPOSE 6379; valkey-cli) (מאגר רשמי · נקרא 14 באוק׳ 2026)
25. valkey-io/valkey-container: 9.1/alpine docker-entrypoint.sh (chown /data, then setpriv to valkey) (מאגר רשמי · נקרא 14 באוק׳ 2026)
26. Docker Hub: valkey/valkey tag 9.1.2-alpine (= 9-alpine; linux/amd64 18,803,257 B compressed; layers decompressed and counted: 45,906,944 B) (מדידה · נקרא 14 באוק׳ 2026)
27. Gotenberg Docs: Installation (port 3000; non-root user gotenberg 1001; demo on 512 MB / 0.5 CPU; allocate at least 1Gi of memory on Cloud Run) (תיעוד רשמי · נקרא 14 באוק׳ 2026)
28. Gotenberg Docs: Troubleshooting (Office conversion is resource-heavy; raise memory and CPU on 500 errors) (תיעוד רשמי · נקרא 14 באוק׳ 2026)
29. gotenberg repository: build/Dockerfile at v8.37.0 (user gotenberg uid/gid 1001, tini, curl for health checks) (מאגר רשמי · נקרא 14 באוק׳ 2026)
30. Docker Hub: gotenberg/gotenberg tag 8.37.0 (= 8.37; linux/amd64 702,511,386 B compressed; layers decompressed and counted: 1,710,739,968 B) (מדידה · נקרא 14 באוק׳ 2026)
31. apache/tika-docker README (Tika Server on port 9998; minimal and full images; bind to localhost) (מאגר רשמי · נקרא 14 באוק׳ 2026)
32. apache/tika-docker branch_3x: minimal/Dockerfile (USER 35002:35002, JRE only, EXPOSE 9998, no curl or wget) (מאגר רשמי · נקרא 14 באוק׳ 2026)
33. Docker Hub: apache/tika tag 3.3.1.0 (image user 35002:35002; linux/amd64 178,270,478 B compressed; layers decompressed and counted: 401,058,304 B) (מדידה · נקרא 14 באוק׳ 2026)
34. docker-library/postgres: 18/trixie Dockerfile (postgres uid/gid 999, VOLUME /var/lib/postgresql) (מאגר רשמי · נקרא 14 באוק׳ 2026)
35. docker-library/postgres: 18/trixie docker-entrypoint.sh (chown PGDATA, then gosu postgres) (מאגר רשמי · נקרא 14 באוק׳ 2026)
36. PostgreSQL 18 documentation: 19.4 Resource Consumption (תיעוד רשמי · נקרא 10 באוק׳ 2026)
37. PostgreSQL 18 documentation: 19.3 Connections and Authentication (תיעוד רשמי · נקרא 10 באוק׳ 2026)
38. PostgreSQL 18 documentation: 19.10 Vacuuming (autovacuum settings) (תיעוד רשמי · נקרא 10 באוק׳ 2026)
39. PostgreSQL 18 documentation: 19.5 Write Ahead Log (max_wal_size) (תיעוד רשמי · נקרא 10 באוק׳ 2026)
40. PostgreSQL 18 documentation: 51.2 How Connections Are Established (תיעוד רשמי · נקרא 10 באוק׳ 2026)
41. Docker Official Image postgres: documentation (docker-library/docs) (תיעוד רשמי · נקרא 10 באוק׳ 2026)
42. Docker Hub: library/postgres tag 18.6 (compressed image sizes) (מאגר רשמי · נקרא 10 באוק׳ 2026)