PROXY and HTTPS settings via env vars added

Author: manulera

.gitignore

@@ -1,3 +1,6 @@
 .vscode
 .DS_Store
-.env
+.env
+
+# Certificates
+certs/

docker-compose.yml

@@ -3,7 +3,7 @@ version: "3"
 services:
   opencloning:
     build: .
-    image: manulera/opencloning:prod
+    image: manulera/opencloning:local
     ports:
       - "8000:8000"
 
@@ -24,6 +24,23 @@ services:
     # - BACKEND_URL=/opencloning/
     #   Set this if you want to use plannotate
       - PLANNOTATE_URL=http://plannotate:8000
+    # Set this if you want to use a proxy for the external requests made by the backend
+    # (example is using mitmproxy locally on port 8080)
+      - PROXY_URL=http://host.docker.internal:8080
+    # Set this if you want to use a cert file for the proxy (e.g. when testing locally using mitmproxy and USE_HTTPS=true)
+    # This file should be mounted. The path is absolute to the container.
+      - PROXY_CERT_FILE=/certs/proxy.pem
+    # Set to true if you are using HTTPS, you will have to provide cert files (see volumes section)
+      - USE_HTTPS=true
+
+    volumes:
+      - type: bind
+        # Path to your local cert files
+        source: ./certs
+        # They will be mounted as read only at /certs in the container
+        target: /certs
+        read_only: true
+
 
   plannotate:
     image: manulera/plannotate-api

docker_entrypoint.sh

@@ -11,5 +11,15 @@ echo ""
 echo "------------------------------------"
 cd ..
 
-# Only add --root-path if ROOT_PATH is not empty, otherwise uvicorn will throw an error
-uvicorn opencloning.main:app --host 0.0.0.0 --port 8000 ${ROOT_PATH:+--root-path ${ROOT_PATH}}
+
+if [ "$USE_HTTPS" = "true" ]; then
+    echo "Using HTTPS"
+    if [ ! -f "/certs/key.pem" ] || [ ! -f "/certs/cert.pem" ] || [ ! -r "/certs/key.pem" ] || [ ! -r "/certs/cert.pem" ]; then
+        echo "Error: TLS certificate files /certs/key.pem and /certs/cert.pem must both exist and be readable"
+        exit 1
+    fi
+    uvicorn opencloning.main:app --host 0.0.0.0 --port 8000 --ssl-keyfile /certs/key.pem --ssl-certfile /certs/cert.pem ${ROOT_PATH:+--root-path ${ROOT_PATH}}
+else
+    echo "Using HTTP"
+    uvicorn opencloning.main:app --host 0.0.0.0 --port 8000 ${ROOT_PATH:+--root-path ${ROOT_PATH}}
+fi