Merge pull request #1140 from TG1999/use_en_variables_for_throttling

Add env variables for throttling

Author: TG1999

docs/requirements.txt

@@ -1,3 +1,3 @@
 Sphinx>=3.3.1
 sphinx-rtd-theme>=0.5.0
-doc8>=0.8.1
+doc8>=0.8.1

docs/source/misc.rst

@@ -46,3 +46,20 @@ VulnerableCode first checks the file at `/etc/vulnerablecode/.env` and if not
 present, it will attempt to load a `.env` file from the checkout directory.
 
 The file at `/etc/vulnerablecode/.env` has precedence.
+
+
+Throttling rate configuration
+-------------------------------
+
+The default throttling settings are defined in ``settings.py``.
+
+To override the default settings, add env variables in ``.env`` file
+define the settings there. For example::
+
+    VULNERABLECODE_ALL_VULNERABLE_PACKAGES_THROTTLING_RATE = '1000/hour'
+    VULNERABLECODE_BULK_SEARCH_PACKAGE_THROTTLING_RATE = '10/minute'
+    VULNERABLECODE_PACKAGES_SEARCH_THROTTLING_RATE = '1000/second'
+    VULNERABLECODE_VULNERABILITIES_SEARCH_THROTTLING_RATE = '1000/hour'
+    VULNERABLECODE_ALIASES_SEARCH_THROTTLING_RATE = '1000/hour'
+    VULNERABLECODE_CPE_SEARCH_THROTTLING_RATE = '10/minute'
+    VULNERABLECODE_BULK_SEARCH_CPE_THROTTLING_RATE = '10/minute'

vulnerablecode/settings.py

@@ -172,13 +172,21 @@
 LOGOUT_REDIRECT_URL = "/"
 
 REST_FRAMEWORK_DEFAULT_THROTTLE_RATES = {
-    "vulnerable_packages": "1/hour",
-    "bulk_search_packages": "5/hour",
-    "packages": "10/minute",
-    "vulnerabilities": "10/minute",
-    "aliases": "5/minute",
-    "cpes": "5/minute",
-    "bulk_search_cpes": "5/hour",
+    "vulnerable_packages": env.str(
+        "VULNERABLECODE_ALL_VULNERABLE_PACKAGES_THROTTLING_RATE", default="1/hour"
+    ),
+    "bulk_search_packages": env.str(
+        "VULNERABLECODE_BULK_SEARCH_PACKAGE_THROTTLING_RATE", default="5/hour"
+    ),
+    "packages": env.str("VULNERABLECODE_PACKAGES_SEARCH_THROTTLING_RATE", default="10/minute"),
+    "vulnerabilities": env.str(
+        "VULNERABLECODE_VULNERABILITIES_SEARCH_THROTTLING_RATE", default="10/minute"
+    ),
+    "aliases": env.str("VULNERABLECODE_ALIASES_SEARCH_THROTTLING_RATE", default="5/minute"),
+    "cpes": env.str("VULNERABLECODE_CPE_SEARCH_THROTTLING_RATE", default="5/minute"),
+    "bulk_search_cpes": env.str(
+        "VULNERABLECODE_BULK_SEARCH_CPE_THROTTLING_RATE", default="5/minute"
+    ),
 }
 
 if IS_TESTS: