Contents

# Environment Variables

## String formats

Environment variable values can be parsed to Hash or Array at runtime
with the following syntaxes:

* Hash: Variable string `a:1,b:2,c:3` parses to `{a:1, b:2, c:3}` at runtime
* Array: Variable string `a,b,c` parses to `[:a, :b, :c]` at runtime

## Variables

### `WAYFARER_AGENT`
:   Either `ferrum`, `selenium` or `http`.

    * Type: String
    * Key: `config.agent`
    * Default value: `:http`

### `WAYFARER_POOL_SIZE`
:   Number of user agents to maintain.

    * Type: Integer
    * Key: `config.pool_size`
    * Default value: `1`

### `WAYFARER_POOL_TIMEOUT`
:   How long a user agent may remain checked out until the owning job
    fails.

    * Type: Integer
    * Key: `config.agent_pool_timeout`
    * Default value: `1`

---

### `WAYFARER_FERRUM_OPTIONS`
:   Key/value options passed to `Ferrum::Browser.new`.

    * Type: Hash
    * Key: `config.ferrum_options`
    * Default value: `{}`

---

### `WAYFARER_SELENIUM_DRIVER`
:   Driver passed to `Selenium::WebDriver.for`.

    * Type: Symbol
    * Key: `config.selenium_driver`
    * Default value: `:chrome`

---

### `WAYFARER_SELENIUM_OPTIONS`
:   Options passed to `Selenium::WebDriver.for`.

    * Type: Hash
    * Key: `config.selenium_options`
    * Default value: `{}`
    
---

### `WAYFARER_SELENIUM_CLIENT_TIMEOUT`
:   Selenium HTTP client timeout (seconds).

    * Type: Integer
    * Key: `config.selenium_client_timeout`
    * Default value: `60`

---

### `WAYFARER_HTTP_HEADERS`
:   HTTP request headers used when retrieving pages.

    * Type: Hash
    * Key: `config.http_headers`
    * Default value: `{}`
    
    !!! attention "Partial support"

        Selenium does not support configuring HTTP request headers.

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
wayfarer-0.4.6	docs/reference/environment_variables.md
wayfarer-0.4.5	docs/reference/environment_variables.md
wayfarer-0.4.4	docs/reference/environment_variables.md
wayfarer-0.4.3	docs/reference/environment_variables.md
wayfarer-0.4.2	docs/reference/environment_variables.md
wayfarer-0.4.1	docs/reference/environment_variables.md