- type: markdown
attributes:
value: |
- Have a question? 👉 [Start a new discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/new) or [ask in chat](https://matrix.to/#/#paperless:adnidor.de).
+ Have a question? 👉 [Start a new discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/new) or [ask in chat](https://matrix.to/#/#paperlessngx:matrix.org).
Before opening an issue, please double check:
url: https://github.com/paperless-ngx/paperless-ngx/discussions
about: This issue tracker is not for support questions. Please refer to our Discussions.
- name: 💬 Chat
- url: https://matrix.to/#/#paperless:adnidor.de
+ url: https://matrix.to/#/#paperlessngx:matrix.org
about: Want to discuss Paperless-ngx with others? Check out our chat.
- name: 🚀 Feature Request
url: https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=feature-requests
appVersion: "1.9.2"
description: Paperless-ngx - Index and archive all of your scanned paper documents
name: paperless
-version: 10.0.0
+version: 10.0.1
kubeVersion: ">=1.16.0-0"
keywords:
- paperless
MARIADB_USER: paperless
MARIADB_PASSWORD: paperless
MARIADB_ROOT_PASSWORD: paperless
- ports:
- - "3306:3306"
webserver:
image: ghcr.io/paperless-ngx/paperless-ngx:latest
MARIADB_USER: paperless
MARIADB_PASSWORD: paperless
MARIADB_ROOT_PASSWORD: paperless
- ports:
- - "3306:3306"
webserver:
image: ghcr.io/paperless-ngx/paperless-ngx:latest
Options available to any installation of paperless:
-- Use the [document exporter](administration#exporter). The document exporter exports all your documents,
+- Use the [document exporter](#exporter). The document exporter exports all your documents,
thumbnails and metadata to a specific folder. You may import your
documents into a fresh instance of paperless again or store your
documents in another DMS with this export.
## Updating Paperless {#updating}
-### Docker Route
+### Docker Route {#docker-updating}
If a new release of paperless-ngx is available, upgrading depends on how
you installed paperless-ngx in the first place. The releases are
After that, [make a backup](#backup).
-A. If you pull the image from the docker hub, all you need to do is:
+1. If you pull the image from the docker hub, all you need to do is:
- ``` shell-session
- $ docker-compose pull
- $ docker-compose up
- ```
+ ```shell-session
+ $ docker-compose pull
+ $ docker-compose up
+ ```
- The docker-compose files refer to the `latest` version, which is
- always the latest stable release.
+ The docker-compose files refer to the `latest` version, which is
+ always the latest stable release.
-B. If you built the image yourself, do the following:
+2. If you built the image yourself, do the following:
- ``` shell-session
- $ git pull
- $ docker-compose build
- $ docker-compose up
- ```
+ ```shell-session
+ $ git pull
+ $ docker-compose build
+ $ docker-compose up
+ ```
Running `docker-compose up` will also apply any new database migrations.
If you see everything working, press CTRL+C once to gracefully stop
image: ghcr.io/paperless-ngx/paperless-ngx:1.7
```
-### Bare Metal Route
+### Bare Metal Route {#bare-metal-updating}
After grabbing the new release and unpacking the contents, do the
following:
This might not actually do anything. Not every new paperless version
comes with new database migrations.
-## Downgrading Paperless
+## Downgrading Paperless {#downgrade-paperless}
Downgrades are possible. However, some updates also contain database
migrations (these change the layout of the database and may move data).
### Document importer {#importer}
The document importer takes the export produced by the [Document
-exporter](#document-exporter) and imports it into paperless.
+exporter](#exporter) and imports it into paperless.
The importer works just like the exporter. You point it at a directory,
and the script does the rest of the work:
### Managing filenames {#renamer}
If you use paperless' feature to
-[assign custom filenames to your documents](/advanced_usage#file_name_handling), you can use this command to move all your files after
+[assign custom filenames to your documents](/advanced_usage#file-name-handling), you can use this command to move all your files after
changing the naming scheme.
!!! warning
As of October 2022 Microsoft no longer supports IMAP authentication
for Exchange servers, thus Exchange is no longer supported until a
solution is implemented in the Python IMAP library used by Paperless.
- See
-
-[learn.microsoft.com](https://learn.microsoft.com/en-us/exchange/clients-and-mobile-in-exchange-online/deprecation-of-basic-authentication-exchange-online)
+ See [learn.microsoft.com](https://learn.microsoft.com/en-us/exchange/clients-and-mobile-in-exchange-online/deprecation-of-basic-authentication-exchange-online)
### Creating archived documents {#archiver}
documents, such as encrypted PDF documents. The archiver will skip over
these documents each time it sees them.
-### Managing encryption {#encyption}
+### Managing encryption {#encryption}
Documents can be stored in Paperless using GnuPG encryption.
!!! warning
- Encryption is deprecated since paperless-ngx 0.9 and doesn't really
+ Encryption is deprecated since [paperless-ng 0.9](/changelog#paperless-ng-090) and doesn't really
provide any additional security, since you have to store the passphrase
in a configuration file on the same system as the encrypted documents
for paperless to work. Furthermore, the entire text content of the
see the newly-created document, automatically tagged with the
appropriate data.
-### Automatic matching {#automatic_matching}
+### Automatic matching {#automatic-matching}
Paperless-ngx comes with a new matching algorithm called _Auto_. This
matching algorithm tries to assign tags, correspondents, document types,
hood.
If, for example, all your bank statements of your account 123 at the
-Bank of America are tagged with the tag "bofa*123" and the matching
-algorithm of this tag is set to \_Auto*, this neural network will examine
+Bank of America are tagged with the tag "bofa123" and the matching
+algorithm of this tag is set to _Auto_, this neural network will examine
your documents and automatically learn when to assign this tag.
Paperless tries to hide much of the involved complexity with this
of these correspondents to ANY new document, if both are set to
automatic matching.
-## Hooking into the consumption process
+## Hooking into the consumption process {#consume-hooks}
Sometimes you may want to do something arbitrary whenever a document is
consumed. Rather than try to predict what you may want to do, Paperless
asynchronously, you'll have to fork the process in your script and
exit.
-### Pre-consumption script
+### Pre-consumption script {#pre-consume-script}
Executed after the consumer sees a new document in the consumption
folder, but before any processing of the document is performed. This
The script's stdout and stderr will be logged line by line to the
webserver log, along with the exit code of the script.
-### Post-consumption script {#post_consume_script}
+### Post-consumption script {#post-consume-script}
Executed after the consumer has successfully processed a document and
has moved it into paperless. It receives the following environment
The script's stdout and stderr will be logged line by line to the
webserver log, along with the exit code of the script.
-#### Docker
+### Docker {#docker-consume-hooks}
-Assumed you have
-`/home/foo/paperless-ngx/scripts/post-consumption-example.sh`.
+To hook into the consumption process when using Docker, you
+will need to pass the scripts into the container via a host mount
+in your `docker-compose.yml`.
-You can pass that script into the consumer container via a host mount in
-your `docker-compose.yml`.
+Assuming you have
+`/home/paperless-ngx/scripts/post-consumption-example.sh` as a
+script which you'd like to run.
-```bash
+You can pass that script into the consumer container via a host mount:
+
+```yaml
...
-consumer:
+webserver:
...
volumes:
...
- - /home/paperless-ngx/scripts:/path/in/container/scripts/
+ - /home/paperless-ngx/scripts:/path/in/container/scripts/ # (1)!
+ environment: # (3)!
+ ...
+ PAPERLESS_POST_CONSUME_SCRIPT: /path/in/container/scripts/post-consumption-example.sh # (2)!
...
```
-Example (docker-compose.yml):
-`- /home/foo/paperless-ngx/scripts:/usr/src/paperless/scripts`
-
-which in turn requires the variable `PAPERLESS_POST_CONSUME_SCRIPT` in
-`docker-compose.env` to point to
-`/path/in/container/scripts/post-consumption-example.sh`.
-
-Example (docker-compose.env):
-`PAPERLESS_POST_CONSUME_SCRIPT=/usr/src/paperless/scripts/post-consumption-example.sh`
+1. The external scripts directory is mounted to a location inside the container.
+2. The internal location of the script is used to set the script to run
+3. This can also be set in `docker-compose.env`
Troubleshooting:
- Pipe your scripts's output to a log file e.g.
`echo "${DOCUMENT_ID}" | tee --append /usr/src/paperless/scripts/post-consumption-example.log`
-## File name handling {#file_name_handling}
+## File name handling {#file-name-handling}
By default, paperless stores your documents in the media directory and
renames them using the identifier which it has assigned to each
!!! tip
You can affect how empty placeholders are treated by changing the
- following setting to [true]{.title-ref}.
+ following setting to `true`.
```
PAPERLESS_FILENAME_FORMAT_REMOVE_NONE=True
Paperless checks the filename of a document whenever it is saved.
Therefore, you need to update the filenames of your documents and move
them after altering this setting by invoking the
- [`document renamer <utilities-renamer>`]().
+ [`document renamer`](/administration#renamer).
!!! warning
storage paths come to the rescue. Storage paths allow you to configure
more precisely where each document is stored in the file system.
-- Each storage path is a [PAPERLESS_FILENAME_FORMAT]{.title-ref} and
+- Each storage path is a `PAPERLESS_FILENAME_FORMAT` and
follows the rules described above
- Each document is assigned a storage path using the matching
algorithms described above, but can be overwritten at any time
For example, you could define the following two storage paths:
1. Normal communications are put into a folder structure sorted by
- [year/correspondent]{.title-ref}
+ `year/correspondent`
2. Communications with insurance companies are stored in a flat
structure with longer file names, but containing the full date of
the correspondence.
```
If you then map these storage paths to the documents, you might get the
-following result. For simplicity, [By Year]{.title-ref} defines the same
+following result. For simplicity, `By Year` defines the same
structure as in the previous example above.
```text
!!! tip
Defining a storage path is optional. If no storage path is defined for a
- document, the global [PAPERLESS_FILENAME_FORMAT]{.title-ref} is applied.
+ document, the global `PAPERLESS_FILENAME_FORMAT` is applied.
!!! warning
with Prometheus, as it exports metrics. For details on its capabilities,
refer to the Flower documentation.
-To configure Flower further, create a [flowerconfig.py]{.title-ref} and
-place it into the [src/paperless]{.title-ref} directory. For a Docker
+To configure Flower further, create a `flowerconfig.py` and
+place it into the `src/paperless` directory. For a Docker
installation, you can use volumes to accomplish this:
```yaml
services:
# ...
webserver:
+ ports:
+ - 5555:5555 # (2)!
# ...
volumes:
- - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro
+ - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro # (1)!
```
+1. Note the `:ro` tag means the file will be mounted as read only.
+2. `flower` runs by default on port 5555, but this can be configured
+
## Custom Container Initialization
The Docker image includes the ability to run custom user scripts during
startup. This could be utilized for installing additional tools or
-Python packages, for example.
+Python packages, for example. Scripts are expected to be shell scripts.
To utilize this, mount a folder containing your scripts to the custom
-initialization directory, [/custom-cont-init.d]{.title-ref} and place
+initialization directory, `/custom-cont-init.d` and place
scripts you wish to run inside. For security, the folder must be owned
by `root` and should have permissions of `a=rx`. Additionally, scripts
must only be writable by `root`.
Your scripts will be run directly before the webserver completes
-startup. Scripts will be run by the [root]{.title-ref} user.
+startup. Scripts will be run by the `root` user.
If you would like to switch users, the utility `gosu` is available and
preferred over `sudo`.
webserver:
# ...
volumes:
- - /path/to/my/scripts:/custom-cont-init.d:ro
+ - /path/to/my/scripts:/custom-cont-init.d:ro # (1)!
```
+1. Note the `:ro` tag means the folder will be mounted as read only. This is for extra security against changes
+
## MySQL Caveats {#mysql-caveats}
### Case Sensitivity
# The REST API
Paperless makes use of the [Django REST
-Framework](http://django-rest-framework.org/) standard API interface. It
+Framework](https://django-rest-framework.org/) standard API interface. It
provides a browsable API for most of its endpoints, which you can
inspect at `http://<paperless-host>:<port>/api/`. This also documents
most of the available filters and ordering fields.
results:
- `/api/documents/?query=your%20search%20query`: Search for a document
- using a full text query. For details on the syntax, see [Basic Usage - Searching](usage#basic-usage_searching).
+ using a full text query. For details on the syntax, see [Basic Usage - Searching](/usage#basic-usage_searching).
- `/api/documents/?more_like=1234`: Search for documents similar to
the document with id 1234.
Results returned by the endpoint are ordered by importance of the term
in the document index. The first result is the term that has the highest
-Tf/Idf score in the index.
+[Tf/Idf](https://en.wikipedia.org/wiki/Tf%E2%80%93idf) score in the index.
```json
["term1", "term3", "term6", "term4"]
# Changelog
+## paperless-ngx 1.11.0
+
+### Notable Changes
+
+- Feature: frontend paperless mail [@shamoon](https://github.com/shamoon) ([#2000](https://github.com/paperless-ngx/paperless-ngx/pull/2000))
+- Feature: Ability to consume mails and eml files [@p-h-a-i-l](https://github.com/p-h-a-i-l) ([#848](https://github.com/paperless-ngx/paperless-ngx/pull/848))
+
+### Features
+
+- Chore: Downgrade hiredis to 2.0.0 [@stumpylog](https://github.com/stumpylog) ([#2262](https://github.com/paperless-ngx/paperless-ngx/pull/2262))
+- Add ability to provide the configuration file path using an env variable [@hashworks](https://github.com/hashworks) ([#2241](https://github.com/paperless-ngx/paperless-ngx/pull/2241))
+- Feature: Adds option to allow a user to export directly to a zipfile [@stumpylog](https://github.com/stumpylog) ([#2004](https://github.com/paperless-ngx/paperless-ngx/pull/2004))
+- Feature: Adds PaperlessTask admin page interface [@stumpylog](https://github.com/stumpylog) ([#2184](https://github.com/paperless-ngx/paperless-ngx/pull/2184))
+- Feature: speed up frontend by truncating content [@shamoon](https://github.com/shamoon) ([#2028](https://github.com/paperless-ngx/paperless-ngx/pull/2028))
+- Feature: Allow bulk download API to follow file name formatting [@stumpylog](https://github.com/stumpylog) ([#2003](https://github.com/paperless-ngx/paperless-ngx/pull/2003))
+- Feature: Bake NLTK into Docker image [@stumpylog](https://github.com/stumpylog) ([#2129](https://github.com/paperless-ngx/paperless-ngx/pull/2129))
+- Feature: frontend paperless mail [@shamoon](https://github.com/shamoon) ([#2000](https://github.com/paperless-ngx/paperless-ngx/pull/2000))
+- Feature: Ability to consume mails and eml files [@p-h-a-i-l](https://github.com/p-h-a-i-l) ([#848](https://github.com/paperless-ngx/paperless-ngx/pull/848))
+
+### Bug Fixes
+
+- Bugfix: Handle RTL languages better [@stumpylog](https://github.com/stumpylog) ([#1665](https://github.com/paperless-ngx/paperless-ngx/pull/1665))
+- Fixed typo in docs [@mendelk](https://github.com/mendelk) ([#2256](https://github.com/paperless-ngx/paperless-ngx/pull/2256))
+- Fix: support in advanced search, fix tags filter badge count for excluded [@shamoon](https://github.com/shamoon) ([#2205](https://github.com/paperless-ngx/paperless-ngx/pull/2205))
+- Bugfix: Don't run system checks on migrate [@stumpylog](https://github.com/stumpylog) ([#2183](https://github.com/paperless-ngx/paperless-ngx/pull/2183))
+- Bugfix: Decoding task signals could fail on datetime type [@stumpylog](https://github.com/stumpylog) ([#2058](https://github.com/paperless-ngx/paperless-ngx/pull/2058))
+
+### Documentation
+
+- Fixed typo in docs [@mendelk](https://github.com/mendelk) ([#2256](https://github.com/paperless-ngx/paperless-ngx/pull/2256))
+- Docs: More fixes and improvements [@tooomm](https://github.com/tooomm) ([#2203](https://github.com/paperless-ngx/paperless-ngx/pull/2203))
+- Docs: Fix leftover issues from conversion [@tooomm](https://github.com/tooomm) ([#2172](https://github.com/paperless-ngx/paperless-ngx/pull/2172))
+- Docs: Fix broken internal links [@tooomm](https://github.com/tooomm) ([#2165](https://github.com/paperless-ngx/paperless-ngx/pull/2165))
+- Update setup.md [@Weltraumschaf](https://github.com/Weltraumschaf) ([#2157](https://github.com/paperless-ngx/paperless-ngx/pull/2157))
+- Chore: Cleanup of new documentation [@stumpylog](https://github.com/stumpylog) ([#2137](https://github.com/paperless-ngx/paperless-ngx/pull/2137))
+- [Documentation] Add v1.10.2 changelog [@github-actions](https://github.com/github-actions) ([#2114](https://github.com/paperless-ngx/paperless-ngx/pull/2114))
+
+### Maintenance
+
+- Chore: Adds notable label for release drafter [@stumpylog](https://github.com/stumpylog) ([#2200](https://github.com/paperless-ngx/paperless-ngx/pull/2200))
+- Chore: Prevent forks from having failing CI runs by default [@tooomm](https://github.com/tooomm) ([#2166](https://github.com/paperless-ngx/paperless-ngx/pull/2166))
+- Chore: migrate to eslint [@shamoon](https://github.com/shamoon) ([#2199](https://github.com/paperless-ngx/paperless-ngx/pull/2199))
+- Feature: Adds PaperlessTask admin page interface [@stumpylog](https://github.com/stumpylog) ([#2184](https://github.com/paperless-ngx/paperless-ngx/pull/2184))
+- Chore: Changes qpdf to be cross compiled for large speed up [@stumpylog](https://github.com/stumpylog) ([#2181](https://github.com/paperless-ngx/paperless-ngx/pull/2181))
+- Chore: Decrease time to build pikepdf [@stumpylog](https://github.com/stumpylog) ([#2178](https://github.com/paperless-ngx/paperless-ngx/pull/2178))
+- Chore: Minor CI cleanups [@stumpylog](https://github.com/stumpylog) ([#2175](https://github.com/paperless-ngx/paperless-ngx/pull/2175))
+
+### All App Changes
+
+- Add ability to provide the configuration file path using an env variable [@hashworks](https://github.com/hashworks) ([#2241](https://github.com/paperless-ngx/paperless-ngx/pull/2241))
+- Fix: support in advanced search, fix tags filter badge count for excluded [@shamoon](https://github.com/shamoon) ([#2205](https://github.com/paperless-ngx/paperless-ngx/pull/2205))
+- Chore: migrate to eslint [@shamoon](https://github.com/shamoon) ([#2199](https://github.com/paperless-ngx/paperless-ngx/pull/2199))
+- Feature: Adds option to allow a user to export directly to a zipfile [@stumpylog](https://github.com/stumpylog) ([#2004](https://github.com/paperless-ngx/paperless-ngx/pull/2004))
+- Feature: Adds PaperlessTask admin page interface [@stumpylog](https://github.com/stumpylog) ([#2184](https://github.com/paperless-ngx/paperless-ngx/pull/2184))
+- Bugfix: Decoding task signals could fail on datetime type [@stumpylog](https://github.com/stumpylog) ([#2058](https://github.com/paperless-ngx/paperless-ngx/pull/2058))
+- Feature: speed up frontend by truncating content [@shamoon](https://github.com/shamoon) ([#2028](https://github.com/paperless-ngx/paperless-ngx/pull/2028))
+- Feature: Allow bulk download API to follow file name formatting [@stumpylog](https://github.com/stumpylog) ([#2003](https://github.com/paperless-ngx/paperless-ngx/pull/2003))
+- Feature: Bake NLTK into Docker image [@stumpylog](https://github.com/stumpylog) ([#2129](https://github.com/paperless-ngx/paperless-ngx/pull/2129))
+- Chore: Apply live testing backoff logic to new mail tests [@stumpylog](https://github.com/stumpylog) ([#2134](https://github.com/paperless-ngx/paperless-ngx/pull/2134))
+- Feature: frontend paperless mail [@shamoon](https://github.com/shamoon) ([#2000](https://github.com/paperless-ngx/paperless-ngx/pull/2000))
+- Feature: Ability to consume mails and eml files [@p-h-a-i-l](https://github.com/p-h-a-i-l) ([#848](https://github.com/paperless-ngx/paperless-ngx/pull/848))
+
+## paperless-ngx 1.10.2
+
+### Features
+
+- Take ownership of k8s-at-home Helm chart [@alexander-bauer](https://github.com/alexander-bauer) ([#1947](https://github.com/paperless-ngx/paperless-ngx/pull/1947))
+
+### Bug Fixes
+
+- Bugfix: Language code checks around two part languages [@stumpylog](https://github.com/stumpylog) ([#2112](https://github.com/paperless-ngx/paperless-ngx/pull/2112))
+- Bugfix: Redis socket compatibility didn't handle URLs with ports [@stumpylog](https://github.com/stumpylog) ([#2109](https://github.com/paperless-ngx/paperless-ngx/pull/2109))
+- Bugfix: Incompatible URL schemes for socket based Redis [@stumpylog](https://github.com/stumpylog) ([#2092](https://github.com/paperless-ngx/paperless-ngx/pull/2092))
+- Fix doc links in contributing [@tooomm](https://github.com/tooomm) ([#2102](https://github.com/paperless-ngx/paperless-ngx/pull/2102))
+
+### Documentation
+
+- Docs: Some more small MkDocs updates [@tooomm](https://github.com/tooomm) ([#2106](https://github.com/paperless-ngx/paperless-ngx/pull/2106))
+- Chore: Cleans up documentation links [@stumpylog](https://github.com/stumpylog) ([#2104](https://github.com/paperless-ngx/paperless-ngx/pull/2104))
+- Feature: Move docs to material-mkdocs [@shamoon](https://github.com/shamoon) ([#2067](https://github.com/paperless-ngx/paperless-ngx/pull/2067))
+- Chore: Add v1.10.1 changelong [@shamoon](https://github.com/shamoon) ([#2082](https://github.com/paperless-ngx/paperless-ngx/pull/2082))
+
+### Maintenance
+
+- Take ownership of k8s-at-home Helm chart [@alexander-bauer](https://github.com/alexander-bauer) ([#1947](https://github.com/paperless-ngx/paperless-ngx/pull/1947))
+
+### All App Changes
+
+- Bugfix: Language code checks around two part languages [@stumpylog](https://github.com/stumpylog) ([#2112](https://github.com/paperless-ngx/paperless-ngx/pull/2112))
+- Bugfix: Redis socket compatibility didn't handle URLs with ports [@stumpylog](https://github.com/stumpylog) ([#2109](https://github.com/paperless-ngx/paperless-ngx/pull/2109))
+- Bugfix: Incompatible URL schemes for socket based Redis [@stumpylog](https://github.com/stumpylog) ([#2092](https://github.com/paperless-ngx/paperless-ngx/pull/2092))
+
## paperless-ngx 1.10.1
### Features
!!! note
-The changed to the full text searching require you to reindex your
-documents. _The docker image does this automatically, you don't need to
-do anything._ To do this, execute the `document_index reindex`
-management command (see `administration-index`{.interpreted-text
-role="ref"}).
+ The changed to the full text searching require you to reindex your
+ documents. _The docker image does this automatically, you don't need to
+ do anything._ To do this, execute the `document_index reindex`
+ management command (see [Managing the document search index](/administration#index)).
### paperless-ng 1.3.2
- Changes
- The REST API is versioned from this point onwards. This will
allow me to make changes without breaking existing clients. See
- the documentation about `api-versioning`{.interpreted-text
- role="ref"} for details.
+ the documentation about [API versioning](/api#api-versioning) for details.
- Added a color picker for tag colors.
- Added the ability to use the filter for searching the document
content as well.
- Changes to the OCRmyPDF integration
- Added support for deskewing and automatic rotation of
incorrectly rotated pages. This is enabled by default, see
- `configuration-ocr`{.interpreted-text role="ref"}.
+ [OCR settings](/configuration#ocr).
- Better support for encrypted files.
- Better support for various other PDF files: Paperless will now
attempt to force OCR with safe options when OCR fails with the
- Added a docker-specific configuration option to adjust the number of
worker processes of the web server. See
- `configuration-docker`{.interpreted-text role="ref"}.
+ [Docker options](/configuration#docker).
- Some more memory usage optimizations.
- Don't show inbox statistics if no inbox tag is defined.
- Always show top left corner of thumbnails, even for extra wide
documents.
- Added a management command for executing the sanity checker
- directly. See `utilities-sanity-checker`{.interpreted-text
- role="ref"}.
+ directly. See [management utilities](/administration#sanity-checker).
- The weekly sanity check now reports messages in the log files.
- Fixed an issue with the metadata tab not reporting anything in case
of missing files.
management commands, since these also ensure that they're always
executed as the paperless user and you're less likely to run into
permission issues. See
- `utilities-management-commands`{.interpreted-text role="ref"}.
+ [management commands](/administration#management-commands).
### paperless-ng 1.1.0
For status notifications and live updates to work, paperless now
requires an [ASGI](https://asgi.readthedocs.io/en/latest/)-enabled
web server. The docker images uses `gunicorn` and an ASGI-enabled
- worker called [uvicorn](http://www.uvicorn.org/), and there is no
+ worker called [uvicorn](https://www.uvicorn.org/), and there is no
need to configure anything.
For bare metal installations, changes are required for the
status notifications.
Apache `mod_wsgi` users, see
- `this note <faq-mod_wsgi>`{.interpreted-text role="ref"}.
+ [this note](/faq#how-do-i-get-websocket-support-with-apache-mod_wsgi).
- Paperless now offers suggestions for tags, correspondents and types
on the document detail page.
- The document exporter locks the media directory and the database
during execution to ensure that the resulting export is
consistent.
- - See the
- `updated documentation <utilities-exporter>`{.interpreted-text
- role="ref"} for more details.
+ - See the [updated documentation](/administration#exporter) for more details.
- Other changes and additions
- Added a language selector to the settings.
- Added date format options to the settings.
- Thanks to [Jo Vandeginste](https://github.com/jovandeginste),
Paperless has optional support for Office documents such as .docx,
.doc, .odt and more.
- - See the `configuration<configuration-tika>`{.interpreted-text
- role="ref"} on how to enable this feature. This feature requires
- two additional services (one for parsing Office documents and
- metadata extraction and another for converting Office documents
- to PDF), and is therefore not enabled on default installations.
+ - See the [Tika settings](/configuration#tika) on how to enable this
+ feature. This feature requires two additional services (one for
+ parsing Office documents and metadata extraction and another for
+ converting Office documents to PDF), and is therefore not enabled
+ on default installations.
- As with all other documents, paperless converts Office documents
to PDF and stores both the original as well as the archived PDF.
- Dark mode
!!! note
-The bulk delete operations did not update the search index. Therefore,
-documents that you deleted remained in the index and caused the search
-to return messages about missing documents when searching. Further bulk
-operations will properly update the index.
+ The bulk delete operations did not update the search index. Therefore,
+ documents that you deleted remained in the index and caused the search
+ to return messages about missing documents when searching. Further bulk
+ operations will properly update the index.
-However, this change is not retroactive: If you used the delete method
-of the bulk editor, you need to reindex your search index by
-`running the management command document_index with the argument reindex <administration-index>`{.interpreted-text
-role="ref"}.
+ However, this change is not retroactive: If you used the delete method
+ of the bulk editor, you need to reindex your search index by
+ [running the management command `document_index` with the argument `reindex`](/administration#index).
### paperless-ng 0.9.9
edit page. If available, a dropdown menu will appear next to the
download button.
- Many of the configuration options regarding OCR have changed.
- See `configuration-ocr`{.interpreted-text role="ref"} for
- details.
+ See [OCR settings](/configuration#ocr) for details.
- Paperless no longer guesses the language of your documents. It
always uses the language that you specified with
`PAPERLESS_OCR_LANGUAGE`. Be sure to set this to the language
the majority of your documents are in. Multiple languages can be
specified, but that requires more CPU time.
- - The management command
- `document_archiver <utilities-archiver>`{.interpreted-text
- role="ref"} can be used to create archived versions for already
- existing documents.
+ - The management command [`document_archiver`](/administration#archiver)
+ can be used to create archived versions for already existing documents.
- Tags from consumption folder.
- - Thanks to [jayme-github](http://github.com/jayme-github),
+ - Thanks to [jayme-github](https://github.com/jayme-github),
paperless now consumes files from sub folders in the consumption
folder and is able to assign tags based on the sub folders a
document was found in. This can be configured with
- The endpoint for uploading documents now supports specifying
custom titles, correspondents, tags and types. This can be used
by clients to override the default behavior of paperless. See
- `api-file_uploads`{.interpreted-text role="ref"}.
+ [POSTing documents](/api#file-uploads).
- The document endpoint of API now serves documents in this form:
- correspondents, document types and tags are referenced by
their ID in the fields `correspondent`, `document_type` and
- Paperless now supports searching by tags, types and dates and
correspondents. In order to have this applied to your existing
documents, you need to perform a `document_index reindex`
- management command (see `administration-index`{.interpreted-text
- role="ref"}) that adds the data to the search index. You only
- need to do this once, since the schema of the search index
- changed. Paperless keeps the index updated after that whenever
- something changes.
+ management command (see [document search index](/administration#index))
+ that adds the data to the search index. You only need to do this
+ once, since the schema of the search index changed. Paperless
+ keeps the index updated after that whenever something changes.
- Paperless now has spelling corrections ("Did you mean") for
miss-typed queries.
- The documentation contains
- `information about the query syntax <basic-searching>`{.interpreted-text
- role="ref"}.
+ [information about the query syntax](/usage#basic-usage_searching).
- Front end:
- Clickable tags, correspondents and types allow quick filtering
for related documents.
### paperless-ng 0.9.0
-- **Deprecated:** GnuPG.
- `See this note on the state of GnuPG in paperless-ng. <utilities-encyption>`{.interpreted-text
- role="ref"} This features will most likely be removed in future
- versions.
+- **Deprecated:** GnuPG. [See this note on the state of GnuPG in paperless-ng.](/administration#encryption)
+ This features will most likely be removed in future versions.
- **Added:** New frontend. Features:
- Single page application: It's much more responsive than the
django admin pages.
uses PostgreSQL instead of SQLite. Username, database and
password all default to `paperless` if not specified.
- **Modified \[breaking\]:** document_retagger management command
- rework. See `utilities-retagger`{.interpreted-text role="ref"} for
+ rework. See [Document retagger](/administration#retagger) for
details. Replaces `document_correspondents` management command.
- **Removed \[breaking\]:** Reminders.
- **Removed:** All customizations made to the django admin pages.
### 2.5.0
- **New dependency**: Paperless now optimises thumbnail generation
- with [optipng](http://optipng.sourceforge.net/), so you'll need to
+ with [optipng](https://optipng.sourceforge.net/), so you'll need to
install that somewhere in your PATH or declare its location in
`PAPERLESS_OPTIPNG_BINARY`. The Docker image has already been
updated on the Docker Hub, so you just need to pull the latest one
[More information on securing your Redis
Instance](https://redis.io/docs/getting-started/#securing-redis).
- Defaults to <redis://localhost:6379>.
+ Defaults to `redis://localhost:6379`.
`PAPERLESS_DBENGINE=<engine_name>`
: Optional, gives the ability to choose Postgres or MariaDB for
-database engine. Available options are [postgresql]{.title-ref} and
-[mariadb]{.title-ref}.
+database engine. Available options are `postgresql` and
+`mariadb`.
- Default is [postgresql]{.title-ref}.
+ Default is `postgresql`.
!!! warning
- Using MariaDB comes with some caveats. See [MySQL Caveats](advanced_usage#mysql-caveats).
+ Using MariaDB comes with some caveats. See [MySQL Caveats](/advanced_usage#mysql-caveats).
`PAPERLESS_DBHOST=<hostname>`
`PAPERLESS_FILENAME_FORMAT=<format>`
: Changes the filenames paperless uses to store documents in the media
-directory. See [File name handling](advanced_usage#file_name_handling) for details.
+directory. See [File name handling](/advanced_usage#file-name-handling) for details.
Default is none, which disables this feature.
`PAPERLESS_FILENAME_FORMAT_REMOVE_NONE=<bool>`
: Tells paperless to replace placeholders in
-[PAPERLESS_FILENAME_FORMAT]{.title-ref} that would resolve to
+`PAPERLESS_FILENAME_FORMAT` that would resolve to
'none' to be omitted from the resulting filename. This also holds
-true for directory names. See [File name handling](advanced_usage#file_name_handling) for
+true for directory names. See [File name handling](/advanced_usage#file-name-handling) for
details.
- Defaults to [false]{.title-ref} which disables this feature.
+ Defaults to `false` which disables this feature.
`PAPERLESS_LOGGING_DIR=<path>`
: This is where paperless will store log files.
- Defaults to "`PAPERLESS_DATA_DIR`/log/".
+ Defaults to `PAPERLESS_DATA_DIR/log/`.
`PAPERLESS_NLTK_DIR=<path>`
: If this environment variable is specified, Paperless automatically
creates a superuser with the provided username at start. This is
useful in cases where you can not run the
-[createsuperuser]{.title-ref} command separately, such as Kubernetes
+`createsuperuser` command separately, such as Kubernetes
or AWS ECS.
- Requires [PAPERLESS_ADMIN_PASSWORD]{.title-ref} to be set.
+ Requires PAPERLESS_ADMIN_PASSWORD be set.
!!! note
`PAPERLESS_ADMIN_MAIL=<email>`
: (Optional) Specify superuser email address. Only used when
-[PAPERLESS_ADMIN_USER]{.title-ref} is set.
+PAPERLESS_ADMIN_USER is set.
Defaults to `root@localhost`.
`PAPERLESS_ADMIN_PASSWORD=<password>`
-: Only used when [PAPERLESS_ADMIN_USER]{.title-ref} is set. This will
+: Only used when PAPERLESS_ADMIN_USER is set. This will
be the password of the automatically created superuser.
`PAPERLESS_COOKIE_PREFIX=<str>`
If you're exposing paperless to the internet directly, do not use
this.
- Also see the warning [in the official documentation
- <https://docs.djangoproject.com/en/3.1/howto/auth-remote-user/#configuration>]{.title-ref}.
+ Also see the warning [in the official documentation](https://docs.djangoproject.com/en/3.1/howto/auth-remote-user/#configuration).
- Defaults to [false]{.title-ref} which disables this feature.
+ Defaults to "false" which disables this feature.
`PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME=<str>`
-: If [PAPERLESS_ENABLE_HTTP_REMOTE_USER]{.title-ref} is enabled, this
+: If "PAPERLESS*ENABLE_HTTP_REMOTE_USER" is enabled, this
property allows to customize the name of the HTTP header from which
the authenticated username is extracted. Values are in terms of
-\[HttpRequest.META\](<https://docs.djangoproject.com/en/3.1/ref/request-response/#django.http.HttpRequest.META>).
-Thus, the configured value must start with [HTTP\_]{.title-ref}
+[HttpRequest.META](https://docs.djangoproject.com/en/3.1/ref/request-response/#django.http.HttpRequest.META).
+Thus, the configured value must start with `HTTP*`
followed by the normalized actual header name.
- Defaults to [HTTP_REMOTE_USER]{.title-ref}.
+ Defaults to "HTTP_REMOTE_USER".
`PAPERLESS_LOGOUT_REDIRECT_URL=<str>`
: URL to redirect the user to after a logout. This can be used
-together with [PAPERLESS_ENABLE_HTTP_REMOTE_USER]{.title-ref} to
+together with PAPERLESS_ENABLE_HTTP_REMOTE_USER to
redirect the user back to the SSO application's logout page.
Defaults to None, which disables this feature.
parsing documents.
It should be a 3-letter language code consistent with ISO 639:
- <https://www.loc.gov/standards/iso639-2/php/code_list.php>
+ https://www.loc.gov/standards/iso639-2/php/code_list.php
Set this to the language most of your documents are written in.
and add the additional services below the webserver service. Watch out
for indentation.
-Make sure to use the correct format [PAPERLESS_TIKA_ENABLED =
-1]{.title-ref} so python_dotenv can parse the statement correctly.
+Make sure to use the correct format `PAPERLESS_TIKA_ENABLED = 1` so python_dotenv can parse the statement correctly.
## Software tweaks {#software_tweaks}
Ensure that the product
- `PAPERLESS_TASK_WORKERS \: PAPERLESS_THREADS_PER_WORKER`
+ `PAPERLESS_TASK_WORKERS * PAPERLESS_THREADS_PER_WORKER`
does not exceed your CPU core count or else paperless will be
extremely slow. If you want paperless to process many documents in
`PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS=<bool>`
: Set the names of subdirectories as tags for consumed files. E.g.
-<CONSUMPTION_DIR>/foo/bar/file.pdf will add the tags "foo" and
+`<CONSUMPTION_DIR>/foo/bar/file.pdf` will add the tags "foo" and
"bar" to the consumed file. Paperless will create any tags that
don't exist yet.
: After a document is consumed, Paperless can trigger an arbitrary
script if you like. This script will be passed a number of arguments
-for you to work with. For more information, take a look at [Post-consumption script](advanced_usage#post_consume_script).
+for you to work with. For more information, take a look at [Post-consumption script](/advanced_usage#post-consume-script).
The default is blank, which means nothing will be executed.
The filename will be checked first, and if nothing is found, the
document text will be checked as normal.
- A date in a filename must have some separators ([.]{.title-ref},
- [-]{.title-ref}, [/]{.title-ref}, etc) for it to be parsed.
+ A date in a filename must have some separators (`.`, `,`, `-`, `/`, etc) for it to be parsed.
Defaults to none, which disables this feature.
These options don't have any effect in `paperless.conf`. These options
adjust the behavior of the docker container. Configure these in
-[docker-compose.env]{.title-ref}.
+`docker-compose.env`.
`PAPERLESS_WEBSERVER_WORKERS=<num>`
There are special setups where you may need to configure this value
to restrict the Ip address or interface the webserver listens on.
- Defaults to \[::\], meaning all interfaces, including IPv6.
+ Defaults to `[::]`, meaning all interfaces, including IPv6.
`PAPERLESS_PORT=<port>`
[Flower](https://flower.readthedocs.io/en/latest/index.html) will be
started by the container.
- You can read more about this in the [advanced documentation](advanced#celery-monitoring).
+ You can read more about this in the [advanced documentation](/advanced_usage#celery-monitoring).
## Update Checking {#update-checking}
## Code formatting with pre-commit Hooks
To ensure a consistent style and formatting across the project source,
-the project utilizes a Git [pre-commit]{.title-ref} hook to perform some
-formatting and linting before a commit is allowed. That way, everyone
-uses the same style and some common issues can be caught early on. See
-below for installation instructions.
+the project utilizes a Git [`pre-commit`](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
+hook to perform some formatting and linting before a commit is allowed.
+That way, everyone uses the same style and some common issues can be caught
+early on. See below for installation instructions.
Once installed, hooks will run when you commit. If the formatting isn't
quite right or a linter catches something, the commit will be rejected.
You'll need to look at the output and fix the issue. Some hooks, such
-as the Python formatting tool [black]{.title-ref}, will format failing
-files, so all you need to do is [git add]{.title-ref} those files again
+as the Python formatting tool `black`, will format failing
+files, so all you need to do is `git add` those files again
and retry your commit.
## Initial setup and first start
following chapters in a certain order:
1. Install prerequisites + pipenv as mentioned in
- `[Bare metal route](/setup#bare_metal)
+ [Bare metal route](/setup#bare_metal)
2. Copy `paperless.conf.example` to `paperless.conf` and enable debug
mode.
$ npm install -g @angular/cli
```
-4. Install pre-commit
+4. Install pre-commit hooks
```shell-session
pre-commit install
mkdir -p consume media
```
-6. You can now either \...
+6. You can now either ...
- install redis or
- spin up a bare redis container
- > ```shell-session
- > docker run -d -p 6379:6379 --restart unless-stopped redis:latest
- > ```
+ ```shell-session
+ docker run -d -p 6379:6379 --restart unless-stopped redis:latest
+ ```
7. Install the python dependencies by performing in the src/ directory.
pipenv install --dev
```
-> - Make sure you're using python 3.9.x or lower. Otherwise you might
-> get issues with building dependencies. You can use
-> [pyenv](https://github.com/pyenv/pyenv) to install a specific
-> python version.
+!!! note
+
+ Make sure you're using python 3.10.x or lower. Otherwise you might
+ get issues with building dependencies. You can use
+ [pyenv](https://github.com/pyenv/pyenv) to install a specific
+ python version.
8. Generate the static UI so you can perform a login to get session
that is required for frontend development (this needs to be done one
you're developing for, you need to have some or all of them
running.
-> ```shell-session
-> python3 manage.py runserver & python3 manage.py document_consumer & celery --app paperless worker
-> ```
+ ```shell-session
+ python3 manage.py runserver & python3 manage.py document_consumer & celery --app paperless worker
+ ```
11. Login with the superuser credentials provided in step 8 at
`http://localhost:8000` to create a session that enables you to use
## Back end development
-The backend is a django application. PyCharm works well for development,
+The backend is a [Django](https://www.djangoproject.com/) application. PyCharm works well for development,
but you can use whatever you want.
Configure the IDE to use the src/ folder as the base source folder.
Configure the following launch configurations in your IDE:
-- python3 manage.py runserver
-- celery \--app paperless worker
-- python3 manage.py document_consumer
+- `python3 manage.py runserver`
+- `celery --app paperless worker`
+- `python3 manage.py document_consumer`
To start them all:
Testing and code style:
-- Run `pytest` in the src/ directory to execute all tests. This also
+- Run `pytest` in the `src/` directory to execute all tests. This also
generates a HTML coverage report. When runnings test, paperless.conf
is loaded as well. However: the tests rely on the default
configuration. This is not ideal. But for now, make sure no settings
except for DEBUG are overridden when testing.
- Coding style is enforced by the Git pre-commit hooks. These will
- ensure your code is formatted and do some linting when you do a [git
- commit]{.title-ref}.
+ ensure your code is formatted and do some linting when you do a `git commit`.
- You can also run `black` manually to format your code
- !!! note
+- The `pre-commit` hooks will modify files and interact with each other.
+ It may take a couple of `git add`, `git commit` cycle to satisfy them.
+
+!!! note
The line length rule E501 is generally useful for getting multiple
source files next to each other on the screen. However, in some
cases, its just not possible to make some lines fit, especially
- complicated IF cases. Append `# NOQA: E501` to disable this check
+ complicated IF cases. Append `# noqa: E501` to disable this check
for certain lines.
## Front end development
## Building the documentation
-The documentation is built using material-mkdocs, see their [documentation](https://squidfunk.github.io/mkdocs-material/reference/). If you want to build the documentation locally, this is how you do it:
+The documentation is built using material-mkdocs, see their [documentation](https://squidfunk.github.io/mkdocs-material/reference/).
+If you want to build the documentation locally, this is how you do it:
1. Install python dependencies.
```shell-session
$ cd /path/to/paperless
- $ pipenv mkdocs build
+ $ pipenv mkdocs build --config-file mkdocs.yml
```
## Building the Docker image
Building the docker image from source:
-> ```shell-session
-> ./build-docker-image.sh Dockerfile -t <your-tag>
-> ```
+```shell-session
+./build-docker-image.sh Dockerfile -t <your-tag>
+```
## Extending Paperless
def get_thumbnail(self, document_path, mime_type):
# This should return the path to a thumbnail you created for this
# document.
- return os.path.join(self.tempdir, "thumb.png")
+ return os.path.join(self.tempdir, "thumb.webp")
```
If you encounter any issues during parsing, raise a
# Frequently Asked Questions
-### _What's the general plan for Paperless-ngx?_
+## _What's the general plan for Paperless-ngx?_
**A:** While Paperless-ngx is already considered largely
"feature-complete" it is a community-driven project and development
guarantee the feature will be implemented. This project will always be
open to collaboration in the form of PRs, ideas etc.
-### _I'm using docker. Where are my documents?_
+## _I'm using docker. Where are my documents?_
**A:** Your documents are stored inside the docker volume
`paperless_media`. Docker manages this volume automatically for you. It
files around manually. This folder is meant to be entirely managed by
docker and paperless.
-### Let's say I want to switch tools in a year. Can I easily move
-
-to other systems?\*
+## Let's say I want to switch tools in a year. Can I easily move to other systems?
**A:** Your documents are stored as plain files inside the media folder.
You can always drag those files out of that folder to use them
- By default, paperless uses the internal ID of each document as its
filename. This might not be very convenient for export. However, you
can adjust the way files are stored in paperless by
- [configuring the filename format](advanced_usage#file_name_handling).
-- [The exporter](administration#exporter) is
+ [configuring the filename format](/advanced_usage#file-name-handling).
+- [The exporter](/administration#exporter) is
another easy way to get your files out of paperless with reasonable
file names.
-### _What file types does paperless-ngx support?_
+## _What file types does paperless-ngx support?_
**A:** Currently, the following files are supported:
-- PDF documents, PNG images, JPEG images, TIFF images and GIF images
- are processed with OCR and converted into PDF documents.
+- PDF documents, PNG images, JPEG images, TIFF images, GIF images and
+ WebP images are processed with OCR and converted into PDF documents.
- Plain text documents are supported as well and are added verbatim to
paperless.
-- With the optional Tika integration enabled (see [Tika configuration](configuration#tika),
+- With the optional Tika integration enabled (see [Tika configuration](/configuration#tika),
Paperless also supports various Office documents (.docx, .doc, odt,
.ppt, .pptx, .odp, .xls, .xlsx, .ods).
Paperless-ngx determines the type of a file by inspecting its content.
The file extensions do not matter.
-### _Will paperless-ngx run on Raspberry Pi?_
+## _Will paperless-ngx run on Raspberry Pi?_
**A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B.
The long answer is that certain parts of Paperless will run very slow,
!!! note
You can adjust some of the settings so that paperless uses less
- processing power. See [setup](setup#less_powerful_devices) for details.
+ processing power. See [setup](/setup#less-powerful-devices) for details.
-### _How do I install paperless-ngx on Raspberry Pi?_
+## _How do I install paperless-ngx on Raspberry Pi?_
-**A:** Docker images are available for arm and arm64 hardware, so just
+**A:** Docker images are available for armv7 and arm64 hardware, so just
follow the docker-compose instructions. Apart from more required disk
space compared to a bare metal installation, docker comes with close to
zero overhead, even on Raspberry Pi.
ARM64. Installation of these will require additional development
libraries and compilation will take a long time.
-### _How do I run this on Unraid?_
+## _How do I run this on Unraid?_
**A:** Paperless-ngx is available as [community
app](https://unraid.net/community/apps?q=paperless-ngx) in Unraid. [Uli
Fahrer](https://github.com/Tooa) created a container template for that.
-### _How do I run this on my toaster?_
+## _How do I run this on my toaster?_
**A:** I honestly don't know! As for all other devices that might be
able to run paperless, you're a bit on your own. If you can't run the
also have a Raspberry Pi, which I occasionally build the image on and
see if it works.
-### _How do I proxy this with NGINX?_
+## _How do I proxy this with NGINX?_
-**A:** See [here](setup#nginx).
+**A:** See [here](/setup#nginx).
-### _How do I get WebSocket support with Apache mod_wsgi_?
+## _How do I get WebSocket support with Apache mod_wsgi_?
**A:** `mod_wsgi` by itself does not support ASGI. Paperless will
continue to work with WSGI, but certain features such as status
**Paperless-ngx** is a _community-supported_ open-source document management system that transforms your
physical documents into a searchable online archive so you can keep, well, _less paper_.
-[Get started](/setup/){ .md-button .md-button--primary .index-callout }
+[Get started](/setup){ .md-button .md-button--primary .index-callout }
[Demo](https://demo.paperless-ngx.com){ .md-button .md-button--secondary target=\_blank }
</div>
Paperless, check out these resources in the documentation:
- [Some screenshots](#screenshots) of the new UI are available.
-- Read [this section](/advanced_usage/#advanced-automatic_matching) if you want to learn about how paperless automates all
+- Read [this section](/advanced_usage#automatic-matching) if you want to learn about how paperless automates all
tagging using machine learning.
-- Paperless now comes with a [proper email consumer](/usage/#usage-email) that's fully tested and production ready.
+- Paperless now comes with a [proper email consumer](/usage#usage-email) that's fully tested and production ready.
- Paperless creates searchable PDF/A documents from whatever you put into the consumption directory. This means
that you can select text in image-only documents coming from your scanner.
-- See [this note](/administration/#utilities-encyption) about GnuPG encryption in paperless-ngx.
+- See [this note](/administration#encryption) about GnuPG encryption in paperless-ngx.
- Paperless is now integrated with a
[task processing queue](/setup#task_processor) that tells you at a glance when and why something is not working.
- The [changelog](/changelog) contains a detailed list of all changes in paperless-ngx.
You can go multiple routes to setup and run Paperless:
-- [Use the easy install docker script](/setup#docker_script)
-- [Pull the image from Docker Hub](/setup#docker_hub)
-- [Build the Docker image yourself](/setup#docker_build)
-- [Install Paperless directly on your system manually (bare metal)](/setup#bare_metal)
+- [Use the easy install docker script](#docker_script)
+- [Pull the image from Docker Hub](#docker_hub)
+- [Build the Docker image yourself](#docker_build)
+- [Install Paperless directly on your system manually (bare metal)](#bare_metal)
The Docker routes are quick & easy. These are the recommended routes.
This configures all the stuff from the above automatically so that it
certain, more updated software. If you want to build these images
your self, that is possible, but beyond the scope of these steps.
-4. Follow steps 3 to 8 of [Docker Setup](setup#docker_hub)
- role="ref"}. When asked to run `docker-compose pull` to pull the
- image, do
+4. Follow steps 3 to 8 of [Docker Setup](#docker_hub). When asked to run
+ `docker-compose pull` to pull the image, do
```shell-session
$ docker-compose build
enabled. This is usually the case, but not always.
4. Get the release archive from
- <https://github.com/paperless-ngx/paperless-ngx/releases>. If you
- clone the git repo as it is, you also have to compile the front end
- by yourself. Extract the archive to a place from where you wish to
- execute it, such as `/opt/paperless`.
+ <https://github.com/paperless-ngx/paperless-ngx/releases>. Extract the
+ archive to a place from where you wish to execute it, such as
+ `/opt/paperless`. If you clone the git repo as it is, you also have to
+ compile the frontend yourself, see [here](/development#front-end-development)
+ and use the `build` step, not `serve`.
-5. Configure paperless. See [configuration](configuration) for details.
+5. Configure paperless. See [configuration](/configuration) for details.
Edit the included `paperless.conf` and adjust the settings to your
needs. Required settings for getting
paperless running are:
- `PAPERLESS_REDIS` should point to your redis server, such as
<redis://localhost:6379>.
- - `PAPERLESS_DBENGINE` optional, and should be one of [postgres,
- mariadb, or sqlite]{.title-ref}
+ - `PAPERLESS_DBENGINE` optional, and should be one of `postgres`,
+ `mariadb`, or `sqlite`
- `PAPERLESS_DBHOST` should be the hostname on which your
PostgreSQL server is running. Do not configure this to use
SQLite instead. Also configure port, database name, user and
allows third parties to forge authentication credentials.
- `PAPERLESS_URL` if you are behind a reverse proxy. This should
point to your domain. Please see
- [configuration](configuration) for more
+ [configuration](/configuration) for more
information.
Many more adjustments can be made to paperless, especially the OCR
9. Go to `/opt/paperless/src`, and execute the following commands:
```bash
- \# This creates the database schema.
+ # This creates the database schema.
sudo -Hu paperless python3 manage.py migrate
- \# This creates your first paperless user
+ # This creates your first paperless user
sudo -Hu paperless python3 manage.py createsuperuser
```
10. Optional: Test that paperless is working by executing
```bash
- \# This collects static files from paperless and django.
+ # This collects static files from paperless and django.
sudo -Hu paperless python3 manage.py runserver
```
not available for most distributions.
15. Optional: If using the NLTK machine learning processing (see
- `PAPERLESS_ENABLE_NLTK` in [configuration](configuration#software_tweaks) for details),
+ `PAPERLESS_ENABLE_NLTK` in [configuration](/configuration#software_tweaks) for details),
download the NLTK data for the Snowball
Stemmer, Stopwords and Punkt tokenizer to your
`PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK
the docker-compose files from
[here](https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose)
or clone the repository to build the image yourself (see
- [above](/setup#docker_build)). You can
+ [above](#docker_build)). You can
either replace your current paperless folder or put paperless-ngx in
a different location.
after you migrated your existing SQLite database.
5. Adjust `docker-compose.yml` and `docker-compose.env` to your needs.
- See [Docker setup](setup#docker_hub) details on
+ See [Docker setup](#docker_hub) details on
which edits are advised.
6. [Update paperless.](/administration#updating)
!!! warning
MySQL is case insensitive by default, treating values like "Name" and
- "NAME" as identical. See [MySQL caveats](advanced##mysql-caveats) for details.
+ "NAME" as identical. See [MySQL caveats](/advanced_usage#mysql-caveats) for details.
!!! warning
file to `docker-compose.yml`. Remember to adjust the consumption
directory, if necessary.
b) Without docker, configure the database in your `paperless.conf`
- file. See [configuration](configuration) for
+ file. See [configuration](/configuration) for
details.
3. Open a shell and initialize the database:
updated dependencies that do cookie-processing differently) and probably
your cache as well.
-# Considerations for less powerful devices {#less_powerful_devices}
+# Considerations for less powerful devices {#less-powerful-devices}
Paperless runs on Raspberry Pi. However, some things are rather slow on
the Pi and configuring some options in paperless can help improve
more advanced language processing, which can take more memory and
processing time.
-For details, refer to [configuration](configuration).
+For details, refer to [configuration](/configuration).
!!! note
Updating the
- [automatic matching algorithm](/advanced_usage#automatic_matching) takes quite a bit of time. However, the update mechanism
+ [automatic matching algorithm](/advanced_usage#automatic-matching) takes quite a bit of time. However, the update mechanism
checks if your data has changed before doing the heavy lifting. If you
experience the algorithm taking too much cpu time, consider changing the
schedule in the admin interface to daily. You can also manually invoke
```
The `PAPERLESS_URL` configuration variable is also required when using a
-reverse proxy. Please refer to the [hosting and security](configuration#hosting-and-security) docs.
+reverse proxy. Please refer to the [hosting and security](/configuration#hosting-and-security) docs.
Also read
[this](https://channels.readthedocs.io/en/stable/deploying.html#nginx-supervisor-ubuntu),
warns that
`OCR for XX failed, but we're going to stick with what we've got since FORGIVING_OCR is enabled`,
then you might need to install the [Tesseract language
-files](http://packages.ubuntu.com/search?keywords=tesseract-ocr)
+files](https://packages.ubuntu.com/search?keywords=tesseract-ocr)
marching your document's languages.
As an example, if you are running Paperless-ngx from any Ubuntu or
This happens when paperless does not have permission to delete files
inside the consumption directory. Ensure that `USERMAP_UID` and
`USERMAP_GID` are set to the user id and group id you use on the host
-operating system, if these are different from `1000`. See [Docker setup](setup#docker_hub).
+operating system, if these are different from `1000`. See [Docker setup](/setup#docker_hub).
Also ensure that you are able to read and write to the consumption
directory on the host.
SENDFILE=0
```
- to your [docker-compose.env]{.title-ref} file.
+ to your `docker-compose.env` file.
## Error while reading metadata
## gunicorn fails to start with "is not a valid port number"
You are likely running using Kubernetes, which automatically creates an
-environment variable named [\${serviceName}\_PORT]{.title-ref}. This is
+environment variable named `${serviceName}_PORT`. This is
the same environment variable which is used by Paperless to optionally
change the port gunicorn listens on.
-To fix this, set [PAPERLESS_PORT]{.title-ref} again to your desired
-port, or the default of 8000.
+To fix this, set `PAPERLESS_PORT` again to your desired port, or the
+default of 8000.
# Usage Overview
Paperless is an application that manages your personal documents. With
-the help of a document scanner (see [the scanners wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Scanner-&-Software-Recommendations)), paperless transforms your wieldy physical document binders
-into a searchable archive and provides many utilities for finding and
-managing your documents.
+the help of a document scanner (see [the scanners wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Scanner-&-Software-Recommendations)),
+paperless transforms your unwieldy physical document binders into a searchable archive
+and provides many utilities for finding and managing your documents.
## Terms and definitions
date you signed a contract, or the date a letter was sent to you.
- The _archive serial number_ (short: ASN) of a document is the
identifier of the document in your physical document binders. See
- [recommended workflow](#usage-reccomended_workflow) below.
+ [recommended workflow](#usage-recommended-workflow) below.
- The _content_ of a document is the text that was OCR'ed from the
document. This text is fed into the search engine and is used for
matching tags, correspondents and document types.
### The consumption directory
The primary method of getting documents into your database is by putting
-them in the consumption directory. The consumer runs in an infinite
-loop, looking for new additions to this directory. When it finds them,
+them in the consumption directory. The consumer waits patiently, looking
+for new additions to this directory. When it finds them,
the consumer goes about the process of parsing them with the OCR,
indexing what it finds, and storing it in the media directory.
setup some sort of service to accept the files from the scanner.
Typically, you're looking at an FTP server like
[Proftpd](http://www.proftpd.org/) or a Windows folder share with
-[Samba](http://www.samba.org/).
+[Samba](https://www.samba.org/).
### Web UI Upload
### Mobile upload {#usage-mobile_upload}
-The mobile app over at <https://github.com/qcasey/paperless_share>
+The mobile app over at [https://github.com/qcasey/paperless_share](https://github.com/qcasey/paperless_share)
allows Android users to share any documents with paperless. This can be
combined with any of the mobile scanning apps out there, such as Office
Lens.
### REST API
-You can also submit a document using the REST API, see [docs][api#file-uploads]
+You can also submit a document using the REST API, see [POSTing documents](/api#file-uploads)
for details.
## Best practices {#basic-searching}
details on what date parsing utilities are available, see [Date
parsing](https://whoosh.readthedocs.io/en/latest/dates.html#parsing-date-queries).
-## The recommended workflow {#usage-recommended_workflow}
+## The recommended workflow {#usage-recommended-workflow}
Once you have familiarized yourself with paperless and are ready to use
it for all your documents, the recommended workflow for managing your
paperless will assign them automatically. After consuming a couple
documents, you can even ask paperless to *learn* when to assign tags and
correspondents by itself. For details on this feature, see
- [advanced matching](advanced_usage#matching).
+ [advanced matching](/advanced_usage#matching).
### Task management
performed the task associated with the document, move it to the
inbox.
-## Architectue
+## Architecture
Paperless-ngx consists of the following components:
- navigation.tabs
- navigation.top
- toc.integrate
+ - content.code.annotate
icon:
repo: fontawesome/brands/github
favicon: assets/favicon.png
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences
+ - pymdownx.inlinehilite
+strict: true
nav:
- index.md
- setup.md
apiBaseUrl: document.baseURI + 'api/',
apiVersion: '2',
appTitle: 'Paperless-ngx',
- version: '1.10.2-dev',
+ version: '1.11.0',
webSocketHost: window.location.host,
webSocketProtocol: window.location.protocol == 'https:' ? 'wss:' : 'ws:',
webSocketBaseUrl: base_url.pathname + 'ws/',
from typing import Final
from typing import Tuple
-__version__: Final[Tuple[int, int, int]] = (1, 10, 2)
+__version__: Final[Tuple[int, int, int]] = (1, 11, 0)
# Version string like X.Y.Z
__full_version_str__: Final[str] = ".".join(map(str, __version__))
# Version string like X.Y
projects / thirdparty / paperless-ngx.git / commitdiff
