feat: Added env var for allowing docs

Author: GermanMT

app/config.py

@@ -10,7 +10,8 @@ class Settings(BaseSettings):
     VULN_DB_URI: str = ""
     VULN_DB_USER: str = ""
     VULN_DB_PASSWORD: str = ""
-    ALLOWED_ORIGINS: list[str] = []
+    DOCS_URL: str | None = None
+    SERVICES_ALLOWED_ORIGINS: list[str] = []
     ALGORITHM: str = ""
     JWT_ACCESS_SECRET_KEY: str = ""
     GITHUB_GRAPHQL_API_KEY: str = ""

app/main.py

@@ -15,6 +15,7 @@
 from app.limiter import limiter
 from app.middleware import log_request_middleware
 from app.router import api_router
+from app.config import settings
 
 DESCRIPTION = """
 Depex is a tool that allows you to reason over the entire configuration space of the Software Supply Chain of an open-source software repository.
@@ -27,6 +28,7 @@ async def lifespan(app: FastAPI):
 
 app = FastAPI(
     title="Secure Chain Depex Tool",
+    docs_url=settings.DOCS_URL,
     version="1.0.0",
     description=DESCRIPTION,
     contact={
@@ -45,7 +47,7 @@ async def lifespan(app: FastAPI):
 app.middleware("http")(log_request_middleware)
 app.add_middleware(
     CORSMiddleware,
-    allow_origins=settings.ALLOWED_ORIGINS,
+    allow_origins=settings.SERVICES_ALLOWED_ORIGINS,
     allow_credentials=True,
     allow_methods=["*"],
     allow_headers=["*"],

template.env

@@ -1,7 +1,7 @@
 # For dockerized backend and database
 GRAPH_DB_URI='bolt://neo4j:7687'
 VULN_DB_URI='mongodb://mongoSecureChain:mongoSecureChain@mongodb:27017/admin'
-ALLOWED_ORIGINS='["http://localhost:8000"]'
+DOCS_URL='/docs' # Comment this on production
 
 # Databases settings
 GRAPH_DB_USER='neo4j'
@@ -10,11 +10,12 @@ VULN_DB_USER='mongoSecureChain'
 VULN_DB_PASSWORD='mongoSecureChain'
 
 # Secrets for JWT
-ALGORITHM = 'your_preferred_algorithm'  # e.g., 'HS256'
-ACCESS_TOKEN_EXPIRE_MINUTES = 'access_token_expire_minutes'
-REFRESH_TOKEN_EXPIRE_DAYS = 'refresh_token_expire_days'
-JWT_ACCESS_SECRET_KEY = 'your_access_secret_key' # Need to be equal to the one in other services
-JWT_REFRESH_SECRET_KEY = 'your_refresh_secret_key'
+SECURE_COOKIES=False # Set to True in production
+ALGORITHM='your_preferred_algorithm'  # e.g., 'HS256'
+ACCESS_TOKEN_EXPIRE_MINUTES='access_token_expire_minutes'
+REFRESH_TOKEN_EXPIRE_DAYS='refresh_token_expire_days'
+JWT_ACCESS_SECRET_KEY='your_access_secret_key'
+JWT_REFRESH_SECRET_KEY='your_refresh_secret_key'
 
 # Api key for github services
 GITHUB_GRAPHQL_API_KEY='add_your_api_key'