| Port details |
- py-paperless-ngx Community-supported supercharged version of paperless
- 2.15.3_1 deskutils
 =6      2.11.6_1Version of this port present on the latest quarterly branch. - Maintainer: grembo@FreeBSD.org
- Port Added: 2024-02-22 18:36:05
- Last Update: 2025-05-09 09:48:16
- Commit Hash: fbac8b5
- People watching this port, also watch:: postfix, redis, gitea, php81, libxml2
- Also Listed In: python
- License: GPLv3
- WWW:
- https://docs.paperless-ngx.com
- Description:
- Paperless-ngx is a document management system that transforms
your physical documents into a searchable online archive so you
can keep, well, less paper.
Paperless-ngx is the official successor of the original Paperless
and Paperless-ng projects.
  ¦  ¦  ¦  ¦ 
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - Dependency lines:
-
- ${PYTHON_PKGNAMEPREFIX}paperless-ngx>0:deskutils/py-paperless-ngx@${PY_FLAVOR}
- Conflicts:
- CONFLICTS_INSTALL:
- To install the port:
- cd /usr/ports/deskutils/py-paperless-ngx/ && make install clean
- To add the package, run one of these commands:
- pkg install deskutils/py-paperless-ngx
- pkg install py311-paperless-ngx
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above.
NOTE: This is a Python port. Instead of py311-paperless-ngx listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py311-paperless-ngx
- Flavors: there is no flavor information for this port.
- distinfo:
- TIMESTAMP = 1746350043
SHA256 (paperless-ngx-v2.15.3.tar.xz) = 20cd5961b1f91bde5cb6743ae8eb7f8fd98d66ba67d49d5ab030d87c998ac2d1
SIZE (paperless-ngx-v2.15.3.tar.xz) = 78329260
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- py311-Jinja2>=3.1.6 : devel/py-Jinja2@py311
- py311-bleach>=6.2.0 : www/py-bleach@py311
- py311-concurrent-log-handler>=0.9.19 : sysutils/py-concurrent-log-handler@py311
- py311-dateparser>=1.2.1 : devel/py-dateparser@py311
- py311-dj51-channels-redis>=4.2.1 : www/py-dj51-channels-redis@py311
- py311-dj51-django-allauth>=65.7.0_1 : www/py-dj51-django-allauth@py311
- py311-dj51-django-auditlog>=3.0.0 : www/py-dj51-django-auditlog@py311
- py311-dj51-django-celery-results>=2.6.0 : www/py-dj51-django-celery-results@py311
- py311-dj51-django-compression-middleware>=0.5.0 : www/py-dj51-django-compression-middleware@py311
- py311-dj51-django-cors-headers>=4.7.0 : www/py-dj51-django-cors-headers@py311
- py311-dj51-django-extensions>=3.2.3 : www/py-dj51-django-extensions@py311
- py311-dj51-django-filter>=25.1 : www/py-dj51-django-filter@py311
- py311-dj51-django-multiselectfield>=0.1.13 : www/py-dj51-django-multiselectfield@py311
- py311-dj51-django-soft-delete>=1.0.16 : www/py-dj51-django-soft-delete@py311
- py311-dj51-djangorestframework-guardian>=0.3.0 : www/py-dj51-djangorestframework-guardian@py311
- py311-dj51-drf-spectacular>=0.28.0 : www/py-dj51-drf-spectacular@py311
- py311-dj51-drf-writable-nested>=0.7.2 : www/py-dj51-drf-writable-nested@py311
- py311-filelock>=3.17.0 : sysutils/py-filelock@py311
- py311-flower>=2.0.1 : www/py-flower@py311
- py311-gotenberg-client>=0.10.0 : converters/py-gotenberg-client@py311
- py311-granian>=2.2.5 : www/py-granian@py311
- py311-h2>=4.1.0 : www/py-h2@py311
- py311-hiredis>=3.0.0 : databases/py-hiredis@py311
- py311-httptools>=0.6.4 : www/py-httptools@py311
- py311-httpx-oauth>=0.10.1 : www/py-httpx-oauth@py311
- py311-imap-tools>=1.10.0 : mail/py-imap-tools@py311
- py311-inotifyrecursive>=0.3.5_2 : devel/py-inotifyrecursive@py311
- py311-langdetect>=1.0.9 : textproc/py-langdetect@py311
- py311-mysqlclient>=2.2.7 : databases/py-mysqlclient@py311
- py311-nltk>=3.8.1 : textproc/py-nltk@py311
- py311-ocrmypdf>=16.10.0 : textproc/py-ocrmypdf@py311
- py311-pathvalidate>=3.2.3 : devel/py-pathvalidate@py311
- py311-pdf2image>=1.17.0 : graphics/py-pdf2image@py311
- py311-pdftotext>=3.0.0 : textproc/py-pdftotext@py311
- py311-psycopg2>=2.9.10 : databases/py-psycopg2@py311
- py311-python-dotenv>=1.1.0 : www/py-python-dotenv@py311
- py311-python-gnupg>=0.5.1 : security/py-python-gnupg@py311
- py311-python-ipware>=2.0.3 : net/py-python-ipware@py311
- py311-python-magic>=0.4.27 : devel/py-python-magic@py311
- py311-pyzbar>=0.1.9 : graphics/py-pyzbar@py311
- py311-rapidfuzz>=3.13.0 : devel/py-rapidfuzz@py311
- py311-scikit-learn>=1.4.0 : science/py-scikit-learn@py311
- py311-setproctitle>=1.3.3 : devel/py-setproctitle@py311
- py311-sqlite3>0 : databases/py-sqlite3@py311
- py311-tika-client>=0.7.0 : textproc/py-tika-client@py311
- py311-uvloop>=0.21.0 : devel/py-uvloop@py311
- py311-watchdog>=6.0.0 : devel/py-watchdog@py311
- py311-watchfiles>=0.24.0 : devel/py-watchfiles@py311
- py311-websockets>=15.0.1 : devel/py-websockets@py311
- py311-whitenoise>=6.2.0 : www/py-whitenoise@py311
- py311-whoosh>=2.7.4 : textproc/py-whoosh@py311
- py311-pyyaml>=6.0.1 : devel/py-pyyaml@py311
- python3.11 : lang/python311
- Test dependencies:
-
- python3.11 : lang/python311
- Runtime dependencies:
-
- py311-Jinja2>=3.1.6 : devel/py-Jinja2@py311
- py311-bleach>=6.2.0 : www/py-bleach@py311
- py311-concurrent-log-handler>=0.9.19 : sysutils/py-concurrent-log-handler@py311
- py311-dateparser>=1.2.1 : devel/py-dateparser@py311
- py311-dj51-channels-redis>=4.2.1 : www/py-dj51-channels-redis@py311
- py311-dj51-django-allauth>=65.7.0_1 : www/py-dj51-django-allauth@py311
- py311-dj51-django-auditlog>=3.0.0 : www/py-dj51-django-auditlog@py311
- py311-dj51-django-celery-results>=2.6.0 : www/py-dj51-django-celery-results@py311
- py311-dj51-django-compression-middleware>=0.5.0 : www/py-dj51-django-compression-middleware@py311
- py311-dj51-django-cors-headers>=4.7.0 : www/py-dj51-django-cors-headers@py311
- py311-dj51-django-extensions>=3.2.3 : www/py-dj51-django-extensions@py311
- py311-dj51-django-filter>=25.1 : www/py-dj51-django-filter@py311
- py311-dj51-django-multiselectfield>=0.1.13 : www/py-dj51-django-multiselectfield@py311
- py311-dj51-django-soft-delete>=1.0.16 : www/py-dj51-django-soft-delete@py311
- py311-dj51-djangorestframework-guardian>=0.3.0 : www/py-dj51-djangorestframework-guardian@py311
- py311-dj51-drf-spectacular>=0.28.0 : www/py-dj51-drf-spectacular@py311
- py311-dj51-drf-writable-nested>=0.7.2 : www/py-dj51-drf-writable-nested@py311
- py311-filelock>=3.17.0 : sysutils/py-filelock@py311
- py311-flower>=2.0.1 : www/py-flower@py311
- py311-gotenberg-client>=0.10.0 : converters/py-gotenberg-client@py311
- py311-granian>=2.2.5 : www/py-granian@py311
- py311-h2>=4.1.0 : www/py-h2@py311
- py311-hiredis>=3.0.0 : databases/py-hiredis@py311
- py311-httptools>=0.6.4 : www/py-httptools@py311
- py311-httpx-oauth>=0.10.1 : www/py-httpx-oauth@py311
- py311-imap-tools>=1.10.0 : mail/py-imap-tools@py311
- py311-inotifyrecursive>=0.3.5_2 : devel/py-inotifyrecursive@py311
- py311-langdetect>=1.0.9 : textproc/py-langdetect@py311
- py311-mysqlclient>=2.2.7 : databases/py-mysqlclient@py311
- py311-nltk>=3.8.1 : textproc/py-nltk@py311
- py311-ocrmypdf>=16.10.0 : textproc/py-ocrmypdf@py311
- py311-pathvalidate>=3.2.3 : devel/py-pathvalidate@py311
- py311-pdf2image>=1.17.0 : graphics/py-pdf2image@py311
- py311-pdftotext>=3.0.0 : textproc/py-pdftotext@py311
- py311-psycopg2>=2.9.10 : databases/py-psycopg2@py311
- py311-python-dotenv>=1.1.0 : www/py-python-dotenv@py311
- py311-python-gnupg>=0.5.1 : security/py-python-gnupg@py311
- py311-python-ipware>=2.0.3 : net/py-python-ipware@py311
- py311-python-magic>=0.4.27 : devel/py-python-magic@py311
- py311-pyzbar>=0.1.9 : graphics/py-pyzbar@py311
- py311-rapidfuzz>=3.13.0 : devel/py-rapidfuzz@py311
- py311-scikit-learn>=1.4.0 : science/py-scikit-learn@py311
- py311-setproctitle>=1.3.3 : devel/py-setproctitle@py311
- py311-sqlite3>0 : databases/py-sqlite3@py311
- py311-tika-client>=0.7.0 : textproc/py-tika-client@py311
- py311-uvloop>=0.21.0 : devel/py-uvloop@py311
- py311-watchdog>=6.0.0 : devel/py-watchdog@py311
- py311-watchfiles>=0.24.0 : devel/py-watchfiles@py311
- py311-websockets>=15.0.1 : devel/py-websockets@py311
- py311-whitenoise>=6.2.0 : www/py-whitenoise@py311
- py311-whoosh>=2.7.4 : textproc/py-whoosh@py311
- py311-pyyaml>=6.0.1 : devel/py-pyyaml@py311
- gpg2 : security/gnupg
- liberation-fonts-ttf>=2.1.3 : x11-fonts/liberation-fonts-ttf
- optipng : graphics/optipng
- tesseract : graphics/tesseract
- unpaper : graphics/unpaper
- python3.11 : lang/python311
- ImageMagick7>=7 : graphics/ImageMagick7
- There are no ports dependent upon this port
Configuration Options:- ===> The following configuration options are available for py311-paperless-ngx-2.15.3_1:
DOCS=on: Build and/or install documentation
EXAMPLES=on: Build and/or install examples
====> ImageMagick image processing support: you have to select exactly one of them
IMAGICK6_NOX11=off: ImageMagick6 without X11 support
IMAGICK6_X11=off: ImageMagick6 with X11 support
IMAGICK7_NOX11=off: ImageMagick7 without X11 support
IMAGICK7_X11=on: ImageMagick7 with X11 support
===> Use 'make config' to modify these settings
- Options name:
- deskutils_py-paperless-ngx
- USES:
- python shebangfix tar:xz magick:7,run
- pkg-message:
- For install:
- Please see `man paperless-ngx' for details on how to configure paperless.
- If upgrading
- After each upgrade, please check for differences between your config and
the sample configuration installed by the package:
diff -u /usr/local/etc/paperless.conf \
/usr/local/etc/paperless.conf.sample
Then merge in changes as required by editing
/usr/local/etc/paperless.conf.
Database migrations are run automatically on service start, but
it's recommended to run them explicitly, especially on major upgrades:
service paperless-migrate onestart
- If upgrading from < 2.7.2_1:
- Configuration of NLTK data has been fixed in port version 2.7.2_1.
Please modify your /usr/local/etc/paperless.conf based on
`*NLTK*` settings found in /usr/local/etc/paperless.conf.sample.
- Master Sites:
|
| Commit History - (may be incomplete: for full details, see links to repositories near top of page) |
| Commit | Credits | Log message |
|---|
2.15.3_1
09 May 2025 09:48:16
 |
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Fix custom webui endpoint
This brings back paperless_webui_listen_address and
paperless_webui_listen_port, which were turned into
noops by accident during the update.
PR: 286533
Reported by: mfechner |
2.15.3
07 May 2025 10:10:17
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Update to 2.15.3
PR: 286533
Co-authored-by: Sebastian <sko@rostwald.de> |
2.11.6_1
06 May 2025 11:23:24
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Fix gotenberg-client integration
This is required to make paperless-ngx work with the updated
gotenberg-client (0.10.0). |
2.11.6_1
24 Jan 2025 08:49:44
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Fixes to man page and examples |
2.11.6_1
11 Dec 2024 21:53:49
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Add tmpdir config to rc scripts |
2.11.6
20 Nov 2024 11:38:58
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Update to 2.11.6
This also fixes a problem when updating www/py-django-soft-delete
to versions >= 1.0.14.
PR: 282808 |
2.11.0_1
04 Nov 2024 19:23:24
|
Gleb Popov (arrowd)
Author: Malte Krupa |
deskutils/py-paperless-ngx: Fix manpage reference
Pull Request: https://github.com/freebsd/freebsd-ports/pull/310 |
2.11.0
13 Jul 2024 17:05:00
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Update to 2.11.0 |
2.7.2_5
07 Jul 2024 08:05:33
|
Po-Chuan Hsieh (sunpoet) |
devel/py-pyyaml: Move devel/py-yaml to devel/py-pyyaml
- Bump PORTREVISION of dependent ports for dependency change |
2.7.2_4
28 May 2024 15:45:50
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Fix document classifier hanging (2)
Turn paperless symlink into wrapper, this way OMP_NUM_THREADS=1 is
also set when paperless is called outside rc scripts.
PR: 279011
Reported by: freebsd.bugzilla@mail.tinsuke.com |
2.7.2_3
21 May 2024 07:23:23
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Fix document classifier hanging
Set OMP_NUM_THREADS=1 as a workaround (taken from NixOS port).
PR: 279011
Reported by: freebsd.bugzilla@mail.tinsuke.com |
2.7.2_2
12 May 2024 07:06:38
|
Kai Knoblich (kai) |
deskutils/py-paperless-ngx: Change RUN_DEPENDS
* Switch the port from the repo-copied py-dj42-django* ports to the
original ones as they're using Django 4.2 now.
* Some ports were also created directly with a "py-dj42-" prefix to
have a consistent naming scheme of Django 4.2 ports and had no
Django 3.2 counterpart.
After all Django consumers have been changed from Django 3.2 to
Django 4.2 with 680c68fd4d69, these ports are now renamed accordingly.
- From: www/py-dj42-channels-redis
To: www/py-channels-redis
- From: www/py-dj42-django-auditlog(Only the first 15 lines of the commit message are shown above  ) |
2.7.2_1
24 Apr 2024 22:09:29
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Fix pkg-message
MFH: 2024Q2 |
2.7.2_1
24 Apr 2024 21:56:50
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Fixes and improvements
- Fix NLTK configuration in paperless.conf.sample
- Mention snowball_data in NLTK instructions
- Fix sad defect that prevented rc scripts from picking
up configuration data from rc.conf
- Improve startup script documentation
- Document required ACL when using a remote redis instance
- Document how to enable JBIG2 and its potential pitfalls
PR: 278424, 278425, 278426
Reported by: anonymous bugzilla user, netchild
MFH: 2024Q2 |
2.7.2
09 Apr 2024 11:27:56
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Update to 2.7.2
Also, improve paperless-webui rc script to automatically generate
PAPERLESS_SECRET_KEY if not configured. |
2.6.3
30 Mar 2024 19:34:42
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: Update to 2.6.3 |
2.5.0
22 Feb 2024 18:33:06
|
Michael Gmelin (grembo) |
deskutils/py-paperless-ngx: New port
Paperless-ngx is a document management system that transforms
your physical documents into a searchable online archive so you
can keep, well, less paper.
Paperless-ngx is the official successor to the original Paperless
and Paperless-ng projects. |
As an Amazon Associate I earn from qualifying purchases.