fix(infra): Add root_path to FastAPI app (TracecatHQ#289)

* Remove unnessary internal routes in caddyfile

* Add FasdtAPI root_path env var and config

* Update docker compose files

* Remove trailing / in caddy api routes

Author: topher-lo

.env.example

@@ -21,6 +21,8 @@ TRACECAT__SERVICE_KEY=your-tracecat-service-key
 TRACECAT__SIGNING_SECRET=your-tracecat-signing-secret
 # API Service URL
 TRACECAT__API_URL=http://api:8000
+# Root path to deal with extra path prefix behind the reverse proxy
+TRACECAT__API_ROOT_PATH=/api
 # Public Runner URL
 # This is the public URL for incoming webhooks
 # If you wish to expose your webhooks to the internet, you can use a tunneling service like ngrok.

Caddyfile

@@ -1,15 +1,7 @@
 {$BASE_DOMAIN} {
 	bind {$ADDRESS} # Binds to all available network interfaces if not specified
-	handle_path /api/* {
+	handle_path /api* {
 		reverse_proxy http://api:8000
 	}
 	reverse_proxy http://ui:3000
 }
-
-http://api:8000 {
-	reverse_proxy api:8000
-}
-
-temporal:7233 {
-	reverse_proxy temporal:7233
-}

docker-compose.dev.yml

@@ -23,6 +23,7 @@ services:
       DUMP_TRACECAT_RESULT: 0
       LOG_LEVEL: ${LOG_LEVEL}
       TRACECAT__API_URL: ${TRACECAT__API_URL}
+      TRACECAT__API_ROOT_PATH: ${TRACECAT__API_ROOT_PATH}
       TRACECAT__APP_ENV: ${TRACECAT__APP_ENV}
       TRACECAT__DB_ENCRYPTION_KEY: ${TRACECAT__DB_ENCRYPTION_KEY} # Sensitive
       TRACECAT__DB_URI: ${TRACECAT__DB_URI} # Sensitive
@@ -49,6 +50,7 @@ services:
       DUMP_TRACECAT_RESULT: 0
       LOG_LEVEL: ${LOG_LEVEL}
       TRACECAT__API_URL: ${TRACECAT__API_URL}
+      TRACECAT__API_ROOT_PATH: ${TRACECAT__API_ROOT_PATH}
       TRACECAT__APP_ENV: ${TRACECAT__APP_ENV}
       TRACECAT__DB_ENCRYPTION_KEY: ${TRACECAT__DB_ENCRYPTION_KEY} # Sensitive
       TRACECAT__DB_URI: ${TRACECAT__DB_URI} # Sensitive

docker-compose.yml

@@ -20,6 +20,7 @@ services:
     environment:
       LOG_LEVEL: ${LOG_LEVEL}
       TRACECAT__API_URL: ${TRACECAT__API_URL}
+      TRACECAT__API_ROOT_PATH: ${TRACECAT__API_ROOT_PATH}
       TRACECAT__APP_ENV: ${TRACECAT__APP_ENV}
       TRACECAT__DB_ENCRYPTION_KEY: ${TRACECAT__DB_ENCRYPTION_KEY} # Sensitive
       TRACECAT__DB_URI: ${TRACECAT__DB_URI} # Sensitive
@@ -42,6 +43,7 @@ services:
     environment:
       LOG_LEVEL: ${LOG_LEVEL}
       TRACECAT__API_URL: ${TRACECAT__API_URL}
+      TRACECAT__API_ROOT_PATH: ${TRACECAT__API_ROOT_PATH}
       TRACECAT__APP_ENV: ${TRACECAT__APP_ENV}
       TRACECAT__DB_ENCRYPTION_KEY: ${TRACECAT__DB_ENCRYPTION_KEY} # Sensitive
       TRACECAT__DB_URI: ${TRACECAT__DB_URI} # Sensitive

tracecat/api/app.py

@@ -115,6 +115,7 @@ def create_app(**kwargs) -> FastAPI:
         generate_unique_id_function=custom_generate_unique_id,
         lifespan=lifespan,
         default_response_class=ORJSONResponse,
+        root_path=config.TRACECAT__API_ROOT_PATH,
         **kwargs,
     )
     app.logger = logger

tracecat/config.py

@@ -24,6 +24,8 @@
 TRACECAT__DB_ENDPOINT = os.environ.get("TRACECAT__DB_ENDPOINT")
 TRACECAT__DB_PORT = os.environ.get("TRACECAT__DB_PORT")
 
+TRACECAT__API_ROOT_PATH = os.environ.get("TRACECAT__API_ROOT_PATH", "/api")
+
 # TODO: Set this as an environment variable
 TRACECAT__SERVICE_ROLES_WHITELIST = [
     "tracecat-runner",