Add config variable for update check

docs/configuration.rst

@@ -764,3 +764,13 @@ PAPERLESS_OCR_LANGUAGES=<list>
         PAPERLESS_OCR_LANGUAGE=tur
 
     Defaults to none, which does not install any additional languages.
+
+PAPERLESS_ENABLE_UPDATE_CHECK=<bool>
+    Enabling this option enables the check for available updates, which works by
+    loading the version file of the public repository for this project on Github e.g.
+    https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/src/paperless/version.py
+    to determine whether a new version is available. Actual updating of the app must be done manually.
+
+    No tracking data is collected by the app in any way.
+
+    Defaults to true.

paperless.conf.example

@@ -67,6 +67,7 @@
 #PAPERLESS_FILENAME_PARSE_TRANSFORMS=[]
 #PAPERLESS_THUMBNAIL_FONT_NAME=
 #PAPERLESS_IGNORE_DATES=
+#PAPERLESS_ENABLE_UPDATE_CHECK=
 
 # Tika settings
 

src/documents/views.py

@@ -674,22 +674,27 @@ class BulkDownloadView(GenericAPIView):
 
 class RemoteVersionView(GenericAPIView):
     def get(self, request, format=None):
-        try:
+        remote_version = "0.0.0"
-            with urllib.request.urlopen(
+        is_greater = False
-                "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx"
+        if settings.ENABLE_UPDATE_CHECK:
-                + "/main/src/paperless/version.py",
+            try:
-            ) as response:
+                with urllib.request.urlopen(
-                remote = response.read().decode("utf-8")
+                    "https://raw.githubusercontent.com/paperless-ngx"
-            match = re.search("(\\d+, \\d+, \\d+)", remote)
+                    + "/paperless-ngx/main/src/paperless/version.py",
-            if match:
+                ) as response:
-                remote_version = ".".join(match[0].split(", "))
+                    remote = response.read().decode("utf-8")
-        except urllib.error.URLError:
+                match = re.search("(\\d+, \\d+, \\d+)", remote)
-            remote_version = "0.0.0"
+                if match:
+                    remote_version = ".".join(match[0].split(", "))
+            except urllib.error.URLError:
+                logger.debug("An error occured checking for available updates")
 
-        current_version = ".".join([str(_) for _ in version.__version__[:3]])
+            current_version = ".".join([str(_) for _ in version.__version__[:3]])
-        is_greater = packaging_version.parse(remote_version) > packaging_version.parse(
+            is_greater = packaging_version.parse(
-            current_version,
+                remote_version,
-        )
+            ) > packaging_version.parse(
+                current_version,
+            )
 
         return Response(
             {

src/paperless/settings.py

@@ -566,3 +566,5 @@ if os.getenv("PAPERLESS_IGNORE_DATES", ""):
         d = dateparser.parse(s)
         if d:
             IGNORE_DATES.add(d.date())
+
+ENABLE_UPDATE_CHECK = __get_boolean("PAPERLESS_ENABLE_UPDATE_CHECK", "true")