paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-07-28 18:24:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Allow notify user if update checking not explicitly set

Browse Source
This commit is contained in:
Michael Shamoon
2022-04-02 10:10:49 -07:00
parent a4e7877033
commit 440467e304
5 changed files with 51 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/configuration.rst
View File

@@ -765,12 +765,25 @@ PAPERLESS_OCR_LANGUAGES=<list>
Defaults to none, which does not install any additional languages.
.. _configuration-update-checking:
Update Checking
###############
PAPERLESS_ENABLE_UPDATE_CHECK=<bool>
Enable (or disable) the automatic check for available updates. This works by
pinging the releases endpoint of the Github API for the project e.g.
Enable (or disable) the automatic check for available updates. This feature is disabled
by default but if it is not explicitly set Paperless-ngx will show a message about this.
If enabled, the feature works by pinging the the Github API for the latest release e.g.
https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest
to determine whether a new version is available. Actual updating of the app must be done manually.
to determine whether a new version is available.
No tracking data is collected by the app in any way.
Actual updating of the app must still be performed manually.
Defaults to true.
Note that for users of thirdy-party containers e.g. linuxserver.io this notification
may be 'ahead' of a new release from the third-party maintainers.
In either case, no tracking data is collected by the app in any way.
Defaults to none, which disables the feature.