Merge pull request #14 from slashformotion/configuration

Config

Author: Rulrn

Dockerfile

@@ -29,10 +29,14 @@ FROM debian:bookworm-slim
 COPY --from=builder --chown=python:python /python /python
 
 # Copy the application from the builder
-COPY --from=builder --chown=app:app /app /app
+COPY --from=builder --chown=app:app /app/src /app/src
+COPY --from=builder --chown=app:app /app/.venv /app/.venv
 
 # Place executables in the environment at the front of the path
 ENV PATH="/app/.venv/bin:$PATH"
 WORKDIR /app
 # Run the FastAPI application by default
 CMD ["uvicorn", "--host", "0.0.0.0", "src:app"]
+
+LABEL ogr.opencontainer.image.url="https://github.com/slashformotion/typst-http-api/pkgs/container/typst-http-api"
+LABEL org.opencontainers.image.licenses="MIT"

README.md

@@ -51,6 +51,14 @@ services:
       - "8000:8000"
 ```
 
+## Configuration
+
+### Rate limiting
+
+You can enable IP based rate limiting with the following environement variable : `TYPST_HTTP_API_REQUESTS_PER_MINUTES`. Must be an uint32 > 0, it will define the number of requests per minute.
+
+If not defined, rate limiting is disabled.
+
 ## Build the docker image locally
 
 Build the docker image

result.pdf

@@ -9,27 +9,33 @@
 from slowapi import Limiter, _rate_limit_exceeded_handler
 from slowapi.errors import RateLimitExceeded
 from slowapi.util import get_remote_address
+import os
 
 DEFAULT_CHUNK_SIZE = 1024
+REQUEST_PER_MINUTES = os.getenv("TYPST_HTTP_API_REQUESTS_PER_MINUTES")
+
+
+logger = logging.getLogger(__name__)
 
-limiter = Limiter(key_func=get_remote_address)
 app = FastAPI(docs_url=None, redoc_url=None)
-app.state.limiter = limiter
+
+limiter = Limiter(key_func=get_remote_address)
+if REQUEST_PER_MINUTES is not None:
+    app.state.limiter = limiter
+
 app.add_exception_handler(RateLimitExceeded, _rate_limit_exceeded_handler)
 
 
 Instrumentator().instrument(app).expose(app)
 
-logger = logging.getLogger(__name__)
-
 
 class CompilationError(BaseModel):
     reason: str
     content: str
 
 
 @app.post("/")
-@limiter.limit("6/minute")
+@limiter.limit(f"{REQUEST_PER_MINUTES}/minute")
 async def build(request: Request, response: Response):
     typst_bytes = await request.body()
 
@@ -49,5 +55,3 @@ def iterfile(
             yield input_bytes[i : i + chunk_size]
 
     return StreamingResponse(iterfile(res), media_type="application/pdf")
-
-