Env Variables
Maciej Mensfeld edited this page Oct 12, 2023
·
11 revisions
Important
GitHub Wiki is just a mirror of our online documentation.
We highly recommend using our website docs due to Github Wiki limitations. Only some illustrations, links, screencasts, and code examples will work here, and the formatting may be broken.
Please use https://karafka.io/docs.
Karafka's behaviour can be altered with the following environment variables:
| Name | Description |
|---|---|
| KARAFKA_ROOT_DIR | Root dir of the Karafka application. Defaults to the directory in which Bundler was executed (BUNDLE_GEMFILE) |
| KARAFKA_ENV | Karafka app expected environment. If not defined, autodetected based on RAILS_ENV, RACK_ENV with a fallback to development. |
| KARAFKA_BOOT_FILE | Location of Karafka boot file (karafka.rb) or false. Defaults to karafka.rb in the project root directory. May be set to false in case you want to fully control Karafka boot process. |
Home | Getting started | Components | Producing Messages | Consuming messages | Concurrency and multithreading | Error handling and back off policy
This wiki is tracked by git and publicly editable. You are welcome to fix errors and typos. Any defacing or vandalism of content will result in your changes being reverted and you being blocked.