---
hide:
  - toc
---

# Configuration Keys

## `Wayfarer.config.network`

| Runtime config key     | Environment variable                 | Description                                 | Default                          | Supported values                    |
| ---------------------- | ------------------------------------ | ------------------------------------------- | -------------------------------- | ----------------------------------- |
| `network.agent`        | `WAYFARER_NETWORK_AGENT`             | The user agent to use.                      | `:http`                          | `:http`, `:ferrum`, `:selenium`     |
| `network.pool_size`    | `WAYFARER_NETWORK_POOL_SIZE`         | How many user agents to spawn.              | 1                                | Integers                            |
| `network.pool_timeout` | `WAYFARER_NETWORK_POOL_TIMEOUT`      | How long jobs may use an agent in seconds.  | 10                               | Integers                            |
| `network.http_headers` | `WAYFARER_NETWORK_HTTP_HEADERS`      | HTTP headers to append to requests.         | `{}`                             | Hashes                              |

## `Wayfarer.config.ferrum`

| Runtime config key     | Environment variable                 | Description                                 | Default                          | Supported values                    |
| ---------------------- | ------------------------------------ | ------------------------------------------- | -------------------------------- | ----------------------------------- |
| `ferrum.options`       | `WAYFARER_FERRUM_OPTIONS`            | Ferrum options.                             | `{}`                             | Hashes                              |

## `Wayfarer.config.selenium`

| Runtime config key        | Environment variable                 | Description                                 | Default                          | Supported values                    |
| ----------------------    | ------------------------------------ | ------------------------------------------- | -------------------------------- | ----------------------------------- |
| `selenium.driver`         | `WAYFARER_SELENIUM_DRIVER`           | Selenium driver to use.                     | `:chrome`                        | Symbols                             |
| `selenium.options`        | `WAYFARER_SELENIUM_OPTIONS`          | Selenium options.                           | `{}`                             | Hashes                              |
| `selenium.client_timeout` | `WAYFARER_SELENIUM_CLIENT_TIMEOUT`   | Selenium client timeout in seconds.         | 60                               | Integers                            |

## `Wayfarer.config.redis`

| Runtime config key     | Environment variable                 | Description                                 | Default                                    | Supported values                    |
| ---------------------- | ------------------------------------ | ------------------------------------------- | ------------------------------------------ | ----------------------------------- |
| `redis.url`            | `WAYFARER_REDIS_URL`                 | Redis URL to connect to.                    | http://localhost:6379                      | Strings                             |
| `redis.factory`        | n/a                                  | Redis factory lambda.                       | ` ->(redis) { ::Redis.new(url: redis.url)` | Lambdas                             |

## `Wayfarer.config.capybara`

| Runtime config key     | Environment variable                 | Description                                 | Default                          | Supported values                    |
| ---------------------- | ------------------------------------ | ------------------------------------------- | -------------------------------- | ----------------------------------- |
| `capybara.driver`      | `WAYFARER_CAPYBARA_DRIVER`           | The Capybara driver to use.                 | n/a                              | Symbols                             |