Skip to content

Environment variables

VariableRead byValuesEffect
FEEDBACK_INSTRUMENTATION_MODEInstrumentationMiddleware, when createdoff, meta, full (any case)The mode, when mode= is not passed. Unset means meta. Any other value raises ValueError.
FEEDBACK_INSIGHTS_ENABLEDFeedbackInsights, when created with enabled=Nonetrue to enableTurns on usage analytics for the feedback tools. Off otherwise.
FEEDBACK_INSIGHTS_RETENTION_DAYSFeedbackInsights, when created with enabled=Noneinteger, default 90Days analytics metrics are kept in memory. Minimum 1.
FFB_EMBED_API_KEYthe backfill commandthe keyAPI key for --embed-base-url. Another variable can be named with --api-key-env.

Database URLs and embedding endpoints are always passed in code or as command options; the package reads no variable for them. The examples on this site use DATABASE_URL, EMBED_BASE_URL and FFB_EMBED_API_KEY by convention.

These are read by the package’s own tests, not by the library:

VariableEffect
FFB_TEST_DATABASE_URLRuns the PostgreSQL variants of the database tests against this server.
FFB_TEST_EMBED_URL, FFB_TEST_EMBED_KEY, FFB_TEST_EMBED_MODEL, FFB_TEST_EMBED_DIMRuns the live embedding test against a real endpoint.