paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
jonaswinkler 2020-11-27 12:02:36 +01:00
parent 8bcc40a182
commit 202b88632c
1 changed files with 14 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/configuration.rst
View File

@ -193,17 +193,6 @@ PAPERLESS_TIME_ZONE=<timezone>
Defaults to UTC. Defaults to UTC.
PAPERLESS_OCR_PAGES=<num>
Tells paperless to use only the specified amount of pages for OCR. Documents
with less than the specified amount of pages get OCR'ed completely.
Specifying 1 here will only use the first page.
Defaults to 0, which disables this feature and always uses all pages.
PAPERLESS_OCR_LANGUAGE=<lang> PAPERLESS_OCR_LANGUAGE=<lang>
Customize the default language that tesseract will attempt to use when Customize the default language that tesseract will attempt to use when
parsing documents. The default language is used whenever parsing documents. The default language is used whenever
@ -250,6 +239,20 @@ PAPERLESS_OCR_OUTPUT_TYPE=<type>
If not specified, ``pdfa`` is used. Remember that paperless also keeps If not specified, ``pdfa`` is used. Remember that paperless also keeps
the original input file as well as the archived version. the original input file as well as the archived version.
PAPERLESS_OCR_PAGES=<num>
Tells paperless to use only the specified amount of pages for OCR. Documents
with less than the specified amount of pages get OCR'ed completely.
Specifying 1 here will only use the first page.
When combined with ``PAPERLESS_OCR_MODE=redo`` or ``PAPERLESS_OCR_MODE=force``,
paperless will not modify any text it finds on excluded pages and copy it
verbatim.
Defaults to 0, which disables this feature and always uses all pages.
PAPERLESS_OCR_IMAGE_DPI=<num> PAPERLESS_OCR_IMAGE_DPI=<num>
Paperless will OCR any images you put into the system and convert them Paperless will OCR any images you put into the system and convert them
into PDF documents. This is useful if your scanner produces images. into PDF documents. This is useful if your scanner produces images.
@ -300,18 +303,6 @@ PAPERLESS_CONVERT_TMPDIR=<path>
Default is none, which disables the temporary directory. Default is none, which disables the temporary directory.
PAPERLESS_CONVERT_DENSITY=<num>
This setting has a high impact on the physical size of tmp page files,
the speed of document conversion, and can affect the accuracy of OCR
results. Individual results can vary and this setting should be tested
thoroughly against the documents you are importing to see if it has any
impacts either negative or positive.
Testing on limited document sets has shown a setting of 200 can cut the
size of tmp files by 1/3, and speed up conversion by up to 4x
with little impact to OCR accuracy.
Default is 300.
PAPERLESS_OPTIMIZE_THUMBNAILS=<bool> PAPERLESS_OPTIMIZE_THUMBNAILS=<bool>
Use optipng to optimize thumbnails. This usually reduces the size of Use optipng to optimize thumbnails. This usually reduces the size of
thumbnails by about 20%, but uses considerable compute time during thumbnails by about 20%, but uses considerable compute time during
@ -358,8 +349,5 @@ PAPERLESS_CONVERT_BINARY=<path>
PAPERLESS_GS_BINARY=<path> PAPERLESS_GS_BINARY=<path>
Defaults to "/usr/bin/gs". Defaults to "/usr/bin/gs".
PAPERLESS_UNPAPER_BINARY=<path>
Defaults to "/usr/bin/unpaper".
PAPERLESS_OPTIPNG_BINARY=<path> PAPERLESS_OPTIPNG_BINARY=<path>
Defaults to "/usr/bin/optipng". Defaults to "/usr/bin/optipng".