From 440467e304db9f6624e268c1c9ac9e79c79ce4b8 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 2 Apr 2022 10:10:49 -0700 Subject: [PATCH] Allow notify user if update checking not explicitly set --- docs/configuration.rst | 23 +++++++++++--- .../app-frame/app-frame.component.html | 31 +++++++++++++------ .../services/rest/remote-version.service.ts | 1 + src/documents/views.py | 11 ++++--- src/paperless/settings.py | 4 ++- 5 files changed, 51 insertions(+), 19 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 98664f329..1581914c0 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -765,12 +765,25 @@ PAPERLESS_OCR_LANGUAGES= Defaults to none, which does not install any additional languages. + +.. _configuration-update-checking: + +Update Checking +############### + PAPERLESS_ENABLE_UPDATE_CHECK= - 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. diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index e201a7d6e..d90d3b2d9 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -185,17 +185,30 @@
  • {{ versionString }}
    -
    - +
    + Paperless-ngx v{{ appRemoteVersion.version }} is available.
    Click to view.         - - - - - Update available - + + Checking for updates is disabled.
    Click for more information.     +     + + + + + + Update available + + + + + + + + +
    • diff --git a/src-ui/src/app/services/rest/remote-version.service.ts b/src-ui/src/app/services/rest/remote-version.service.ts index 9b1def363..ab1b5a66b 100644 --- a/src-ui/src/app/services/rest/remote-version.service.ts +++ b/src-ui/src/app/services/rest/remote-version.service.ts @@ -6,6 +6,7 @@ import { environment } from 'src/environments/environment' export interface AppRemoteVersion { version: string update_available: boolean + feature_is_set: boolean } @Injectable({ diff --git a/src/documents/views.py b/src/documents/views.py index 5dc5667c3..ff269186c 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -675,8 +675,10 @@ class BulkDownloadView(GenericAPIView): class RemoteVersionView(GenericAPIView): def get(self, request, format=None): remote_version = "0.0.0" - is_greater = False - if settings.ENABLE_UPDATE_CHECK: + is_greater_than_current = False + # TODO: this can likely be removed when frontend settings are saved to DB + feature_is_set = settings.ENABLE_UPDATE_CHECK != "default" + if feature_is_set and settings.ENABLE_UPDATE_CHECK: try: with urllib.request.urlopen( "https://api.github.com/repos/" @@ -692,7 +694,7 @@ class RemoteVersionView(GenericAPIView): logger.debug("An error occured checking for available updates") current_version = ".".join([str(_) for _ in version.__version__[:3]]) - is_greater = packaging_version.parse( + is_greater_than_current = packaging_version.parse( remote_version, ) > packaging_version.parse( current_version, @@ -701,6 +703,7 @@ class RemoteVersionView(GenericAPIView): return Response( { "version": remote_version, - "update_available": is_greater, + "update_available": is_greater_than_current, + "feature_is_set": feature_is_set, }, ) diff --git a/src/paperless/settings.py b/src/paperless/settings.py index 382a2a38b..708be2d33 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -567,4 +567,6 @@ if os.getenv("PAPERLESS_IGNORE_DATES", ""): if d: IGNORE_DATES.add(d.date()) -ENABLE_UPDATE_CHECK = __get_boolean("PAPERLESS_ENABLE_UPDATE_CHECK", "true") +ENABLE_UPDATE_CHECK = os.getenv("PAPERLESS_ENABLE_UPDATE_CHECK", "default") +if ENABLE_UPDATE_CHECK != "default": + ENABLE_UPDATE_CHECK = __get_boolean("PAPERLESS_ENABLE_UPDATE_CHECK", "true")