Refine the available options for RQ_QUEUES settings #1465 (#1467)

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+v34.9.3 (unreleased)
+--------------------
+
+- Refine the available settings for RQ_QUEUES:
+  * Rename the RQ_QUEUES sub-settings to SCANCODEIO_RQ_REDIS_*
+  * Add SCANCODEIO_RQ_REDIS_SSL setting to enable SSL.
+  https://github.com/aboutcode-org/scancode.io/issues/1465
+
 v34.9.2 (2024-12-10)
 --------------------
 

docker.env

@@ -4,6 +4,6 @@ POSTGRES_PASSWORD=scancodeio
 POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=en_US.UTF-8 --lc-ctype=en_US.UTF-8
 
 SCANCODEIO_DB_HOST=db
-SCANCODEIO_REDIS_HOST=redis
+SCANCODEIO_RQ_REDIS_HOST=redis
 SCANCODEIO_ASYNC=True
 SCANCODEIO_WORKSPACE_LOCATION=/var/scancodeio/workspace/

docs/application-settings.rst

@@ -444,3 +444,29 @@ SCANCODEIO_SKOPEO_AUTHFILE_LOCATION
 Specify the path of the Skopeo authentication file using the following setting::
 
     SCANCODEIO_SKOPEO_AUTHFILE_LOCATION="/path/to/auth.json"
+
+.. _scancodeio_settings_job_queue_and_workers:
+
+Job Queue and Workers
+---------------------
+
+ScanCode.io leverages the RQ (Redis Queue) Python library for job queuing and background
+processing with workers.
+
+By default, it is configured to use the "redis" service in the Docker Compose stack.
+
+For deployments where Redis is hosted on a separate system
+(e.g., a cloud-based deployment or a remote Redis server),
+the Redis instance used by RQ can be customized using the following settings::
+
+    SCANCODEIO_RQ_REDIS_HOST=localhost
+    SCANCODEIO_RQ_REDIS_PORT=6379
+    SCANCODEIO_RQ_REDIS_DB=0
+    SCANCODEIO_RQ_REDIS_USERNAME=<username>
+    SCANCODEIO_RQ_REDIS_PASSWORD=<password>
+    SCANCODEIO_RQ_REDIS_DEFAULT_TIMEOUT=360
+
+To enhance security, it is recommended to enable SSL for Redis connections.
+SSL is disabled by default but can be enabled with the following configuration::
+
+    SCANCODEIO_RQ_REDIS_SSL=True

scancodeio/settings.py

@@ -356,10 +356,16 @@
 
 RQ_QUEUES = {
     "default": {
-        "HOST": env.str("SCANCODEIO_REDIS_HOST", default="localhost"),
-        "PORT": env.str("SCANCODEIO_REDIS_PORT", default="6379"),
-        "PASSWORD": env.str("SCANCODEIO_REDIS_PASSWORD", default=""),
-        "DEFAULT_TIMEOUT": env.int("SCANCODEIO_REDIS_DEFAULT_TIMEOUT", default=360),
+        "HOST": env.str("SCANCODEIO_RQ_REDIS_HOST", default="localhost"),
+        "PORT": env.str("SCANCODEIO_RQ_REDIS_PORT", default="6379"),
+        "DB": env.int("SCANCODEIO_RQ_REDIS_DB", default=0),
+        "USERNAME": env.str("SCANCODEIO_RQ_REDIS_USERNAME", default=None),
+        "PASSWORD": env.str("SCANCODEIO_RQ_REDIS_PASSWORD", default=""),
+        "DEFAULT_TIMEOUT": env.int("SCANCODEIO_RQ_REDIS_DEFAULT_TIMEOUT", default=360),
+        # Enable SSL for Redis connections when deploying ScanCode.io in environments
+        # where Redis is hosted on a separate system (e.g., cloud deployment or remote
+        # Redis server) to secure data in transit.
+        "SSL": env.bool("SCANCODEIO_RQ_REDIS_SSL", default=False),
     },
 }