diff --git a/docs/changelog.rst b/docs/changelog.rst index 2b9821408..537e898c7 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -58,6 +58,13 @@ paperless-ng 1.1.0 * 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 ################## diff --git a/docs/configuration.rst b/docs/configuration.rst index 36b124350..a307cc25a 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -72,13 +72,13 @@ PAPERLESS_CONSUMPTION_DIR= container. Change the local consumption directory in the docker-compose.yml file instead. - Defaults to "../consume", relative to the "src" directory. + Defaults to "../consume/", relative to the "src" directory. PAPERLESS_DATA_DIR= This is where paperless stores all its data (search index, SQLite database, classification model, etc). - Defaults to "../data", relative to the "src" directory. + Defaults to "../data/", relative to the "src" directory. PAPERLESS_MEDIA_ROOT= This is where your documents and thumbnails are stored. @@ -86,7 +86,7 @@ PAPERLESS_MEDIA_ROOT= You can set this and PAPERLESS_DATA_DIR to the same folder to have paperless 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= Override the default STATIC_ROOT here. This is where all static files @@ -94,7 +94,7 @@ PAPERLESS_STATICDIR= 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= Changes the filenames paperless uses to store documents in the media directory. @@ -102,6 +102,25 @@ PAPERLESS_FILENAME_FORMAT= Default is none, which disables this feature. +PAPERLESS_LOGGING_DIR= + This is where paperless will store log files. + + Defaults to "``PAPERLESS_DATA_DIR``/log/". + + +Logging +####### + +PAPERLESS_LOGROTATE_MAX_SIZE= + Maximum file size for log files before they are rotated, in bytes. + + Defaults to 1 MiB. + +PAPERLESS_LOGROTATE_MAX_BACKUPS= + Number of rotated log files to keep. + + Defaults to 20. + Hosting & Security ##################