Environment variables

Feature flags allow users to modify parameters that affect the behavior of the whole framework. Choosing the right combination of flags for an indexer project can improve performance, reduce RAM consumption, or enable useful features.

DipDup uses multiple environment variables internally. They read once on process start and usually do not change during runtime. You can either set variables in active shell or create an env file and pass it with -e CLI option. See Config for more details.

env variabledescription
DIPDUP_CIRunning in GitHub Actions
DIPDUP_DEBUGEnable debug logging and additional checks
DIPDUP_DOCKERRunning in Docker
DIPDUP_JSON_LOGLog in JSON format
DIPDUP_LOW_MEMORYReduce the size of caches and buffers for low-memory environments (target is 256 MB)
DIPDUP_NEXTEnable experimental features from the next major release that require schema changes
DIPDUP_NO_SYMLINKDon't create magic symlink in the package root even when used as cwd
DIPDUP_NO_VERSION_CHECKDisable warning about running unstable or out-of-date DipDup version
DIPDUP_PACKAGE_PATHDisable package discovery and use the specified path
DIPDUP_REPLAY_PATHPath to datasource replay files; used in tests (dev only)
DIPDUP_TESTRunning in pytest

You can also access these values as dipdup.env module attributes.

Help and tips -> Join our Discord
Ideas or suggestions -> Issue Tracker
GraphQL IDE -> Open Playground