Environment variables
| Variable | Read by | Values | Effect |
|---|---|---|---|
FEEDBACK_INSTRUMENTATION_MODE | InstrumentationMiddleware, when created | off, meta, full (any case) | The mode, when mode= is not passed. Unset means meta. Any other value raises ValueError. |
FEEDBACK_INSIGHTS_ENABLED | FeedbackInsights, when created with enabled=None | true to enable | Turns on usage analytics for the feedback tools. Off otherwise. |
FEEDBACK_INSIGHTS_RETENTION_DAYS | FeedbackInsights, when created with enabled=None | integer, default 90 | Days analytics metrics are kept in memory. Minimum 1. |
FFB_EMBED_API_KEY | the backfill command | the key | API 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.
Test suite only
Section titled “Test suite only”These are read by the package’s own tests, not by the library:
| Variable | Effect |
|---|---|
FFB_TEST_DATABASE_URL | Runs 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_DIM | Runs the live embedding test against a real endpoint. |