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

documentation

Browse Source
This commit is contained in:
jonaswinkler 2021-02-06 17:22:05 +01:00
parent 5ef6f2697e
commit e8a1fde1c7
2 changed files with 30 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/changelog.rst
View File

@ -58,6 +58,13 @@ paperless-ng 1.1.0
* Better info section in the side bar. * Better info section in the side bar.
* Paperless no longer logs to the database. Instead, logs are written to rotating log files. This solves many "database is locked"
issues on Raspberry Pi, especially when SQLite is used.
* By default, log files are written to ``PAPERLESS_DATA_DIR/log/``. Logging settings can be adjusted with
``PAPERLESS_LOGGING_DIR``, ``PAPERLESS_LOGROTATE_MAX_SIZE`` and
``PAPERLESS_LOGROTATE_MAX_BACKUPS``.
paperless-ng 1.0.0 paperless-ng 1.0.0
################## ##################

27
docs/configuration.rst
View File

@ -72,13 +72,13 @@ PAPERLESS_CONSUMPTION_DIR=<path>
container. Change the local consumption directory in the docker-compose.yml container. Change the local consumption directory in the docker-compose.yml
file instead. file instead.
Defaults to "../consume", relative to the "src" directory. Defaults to "../consume/", relative to the "src" directory.
PAPERLESS_DATA_DIR=<path> PAPERLESS_DATA_DIR=<path>
This is where paperless stores all its data (search index, SQLite database, This is where paperless stores all its data (search index, SQLite database,
classification model, etc). classification model, etc).
Defaults to "../data", relative to the "src" directory. Defaults to "../data/", relative to the "src" directory.
PAPERLESS_MEDIA_ROOT=<path> PAPERLESS_MEDIA_ROOT=<path>
This is where your documents and thumbnails are stored. This is where your documents and thumbnails are stored.
@ -86,7 +86,7 @@ PAPERLESS_MEDIA_ROOT=<path>
You can set this and PAPERLESS_DATA_DIR to the same folder to have paperless You can set this and PAPERLESS_DATA_DIR to the same folder to have paperless
store all its data within the same volume. store all its data within the same volume.
Defaults to "../media", relative to the "src" directory. Defaults to "../media/", relative to the "src" directory.
PAPERLESS_STATICDIR=<path> PAPERLESS_STATICDIR=<path>
Override the default STATIC_ROOT here. This is where all static files Override the default STATIC_ROOT here. This is where all static files
@ -94,7 +94,7 @@ PAPERLESS_STATICDIR=<path>
Unless you're doing something fancy, there is no need to override this. Unless you're doing something fancy, there is no need to override this.
Defaults to "../static", relative to the "src" directory. Defaults to "../static/", relative to the "src" directory.
PAPERLESS_FILENAME_FORMAT=<format> PAPERLESS_FILENAME_FORMAT=<format>
Changes the filenames paperless uses to store documents in the media directory. Changes the filenames paperless uses to store documents in the media directory.
@ -102,6 +102,25 @@ PAPERLESS_FILENAME_FORMAT=<format>
Default is none, which disables this feature. Default is none, which disables this feature.
PAPERLESS_LOGGING_DIR=<path>
This is where paperless will store log files.
Defaults to "``PAPERLESS_DATA_DIR``/log/".
Logging
#######
PAPERLESS_LOGROTATE_MAX_SIZE=<num>
Maximum file size for log files before they are rotated, in bytes.
Defaults to 1 MiB.
PAPERLESS_LOGROTATE_MAX_BACKUPS=<num>
Number of rotated log files to keep.
Defaults to 20.
Hosting & Security Hosting & Security
################## ##################