Add a run-docker-dev Makefile command (#1480)

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

Author: tdruez

Makefile

@@ -121,6 +121,10 @@ sqlitedb:
 run:
 	${MANAGE} runserver 8001 --insecure
 
+run-docker-dev:
+	@echo "-> Run the Docker compose services in dev mode (hot reload on code changes)"
+	docker compose -f docker-compose.yml -f docker-compose.dev.yml up
+
 test:
 	@echo "-> Run the test suite"
 	${MANAGE} test --noinput
@@ -156,4 +160,4 @@ offline-package: docker-images
 	@mkdir -p dist/
 	@tar -cf dist/scancodeio-offline-package-`git describe --tags`.tar build/
 
-.PHONY: virtualenv conf dev envfile install doc8 check valid check-deploy clean migrate upgrade postgresdb sqlitedb backupdb run test fasttest docs bump docker-images offline-package
+.PHONY: virtualenv conf dev envfile install doc8 check valid check-deploy clean migrate upgrade postgresdb sqlitedb backupdb run run-docker-dev test fasttest docs bump docker-images offline-package

docker-compose.dev.yml

@@ -7,9 +7,13 @@
 
 services:
   web:
+    env_file:
+      - docker.dev.env
     volumes:
       - ./scanpipe:/opt/scancodeio/scanpipe
 
   worker:
+    env_file:
+      - docker.dev.env
     volumes:
       - ./scanpipe:/opt/scancodeio/scanpipe

docker-compose.yml

@@ -22,7 +22,7 @@ services:
     command: wait-for-it --strict --timeout=60 db:5432 -- sh -c "
         ./manage.py migrate &&
         ./manage.py collectstatic --no-input --verbosity 0 --clear &&
-        gunicorn scancodeio.wsgi:application --bind :8000 --timeout 600 --workers 8"
+        gunicorn scancodeio.wsgi:application --bind :8000 --timeout 600 --workers 8 ${GUNICORN_RELOAD_FLAG}"
     env_file:
       - docker.env
     expose:

docker.dev.env

@@ -0,0 +1,2 @@
+SCANCODEIO_DEBUG=True
+GUNICORN_RELOAD_FLAG=--reload

docs/installation.rst

@@ -343,7 +343,10 @@ production servers.
         make sqlitedb
 
 .. warning::
-    Choosing SQLite over PostgreSQL has some caveats. Check this `link
+    SQLite is not recommended as a database backend. Certain built-in pipelines
+    depend on PostgreSQL-specific features and will fail when using SQLite.
+    For full functionality and reliability, PostgreSQL should be used.
+    Check this `link
     <https://docs.djangoproject.com/en/dev/ref/databases/#sqlite-notes>`_
     for more details.