Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions setup/env-variables/backend-env-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
| `HACKNEY_DEFAULT_POOL_SIZE` | Size of `default` hackney pool. Implemented in [#12406](https://github.com/blockscout/blockscout/pull/12406). | Version: v8.1.0\+ <br />Default: `1000` <br />Applications: API, Indexer |
| `UNIVERSAL_PROXY_CONFIG_URL` | Config URL for universal proxy. Implemented in [#12442](https://github.com/blockscout/blockscout/pull/12442). | Version: v8.1.0\+ <br />Default: `https://raw.githubusercontent.com/blockscout/backend-configs/refs/heads/main/universal-proxy-config.json` <br />Applications: API |
| `UNIVERSAL_PROXY_CONFIG` | JSON-encoded configuration string used to define settings for the universal proxy. Implemented in [#13787](https://github.com/blockscout/blockscout/pull/13787). | Version: v10.0.0\+ <br />Default: (empty) <br />Applications: API |
| `K8S_SERVICE` | Kubernetes service name for Elixir nodes clusterization, more info on how to configure it can be found here https://hexdocs.pm/libcluster/Cluster.Strategy.Kubernetes.DNS.html. Implemented in [#13080](https://github.com/blockscout/blockscout/pull/13080). | Version: v9.2.0\+ <br />Default: (empty) <br />Applications: API, Indexer |

Check warning on line 144 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L144

Did you really mean 'clusterization'?

## Database Management

Expand Down Expand Up @@ -188,6 +188,7 @@
| `ETHEREUM_JSONRPC_HTTP_HEADERS` | Custom headers for JSON RPC endpoint in form of json object, example: `{"x-api-key": "nbvkhadvnbkdfav", "x-id": "ndjkfvndfkjv"}`. Implemented in [#7898](https://github.com/blockscout/blockscout/pull/7898) | Version: v5.2.1\+ <br />Default: (empty) <br />Applications: API, Indexer |
| `ETHEREUM_JSONRPC_WAIT_PER_TIMEOUT` | Wait time for each recent timeout from node. Implemented in [#8292](https://github.com/blockscout/blockscout/pull/8292) | Version: v5.2.3\+ <br />Default: `20s` <br />Applications: API, Indexer |
| `ETHEREUM_JSONRPC_HTTP_GZIP_ENABLED` | If `true`, then send gzip encoding header and expect encoding in response. Implemented in [#11292](https://github.com/blockscout/blockscout/pull/11292). | Version: v6.10.0\+ <br />Default: `false` <br />Applications: API, Indexer |
| `ETHEREUM_JSONRPC_HTTP_BATCH_SIZE` | Max http requests count in one batch. Implemented in [#14319](https://github.com/blockscout/blockscout/pull/14319). | Version: master <br />Default: `500` <br />Applications: API, Indexer |
| `IPC_PATH` | Path to the IPC file of the running node if IPC transport is chosen. | Version: v2.1.1\+ <br />Default: (empty) <br />Applications: API, Indexer |


Expand Down Expand Up @@ -275,7 +276,7 @@
| `INDEXER_RECEIPTS_BATCH_SIZE` | Batch size for transaction receipts fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0\+ <br />Default: `250` <br />Applications: Indexer |
| `INDEXER_RECEIPTS_CONCURRENCY` | Concurrency for transaction receipts fetcher. Implemented in [#6454](https://github.com/blockscout/blockscout/pull/6454). | Version: v5.0.0\+ <br />Default: `10` <br />Applications: Indexer |
| `INDEXER_SIGNED_AUTHORIZATION_STATUS_BATCH_SIZE` | Batch size (number of blocks) for EIP7702 authorizations status fetcher. Implemented in [#12451](https://github.com/blockscout/blockscout/pull/12451). | Version: v9.0.0\+ <br />Default: `10` <br />Applications: Indexer |
| `INDEXER_FHE_OPERATIONS_ENABLED` | Flag to enable parsing of Fully Homomorphic Encryption (FHE) operations from transactions. Implemented in [#13742](https://github.com/blockscout/blockscout/pull/13742). | Version: v11.0.0\+ <br />Default: `false` <br />Applications: Indexer |

Check warning on line 279 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L279

Did you really mean 'Homomorphic'?
| `INDEXER_SYSTEM_MEMORY_PERCENTAGE` | Percentage of total memory available to the VM that an application can use if `INDEXER_MEMORY_LIMIT` is not set. Implemented in [#10697](https://github.com/blockscout/blockscout/pull/10697). | Version: v6.9.0\+ <br />Default: `60` <br />Applications: Indexer |
| `INDEXER_ARCHIVAL_TOKEN_BALANCES_BATCH_SIZE` | Batch size for archival token balances fetcher. Implemented in [#7439](https://github.com/blockscout/blockscout/pull/7439). | Version: v10.0.0\+ <br />Default: `100` <br />Applications: Indexer |
| `INDEXER_ARCHIVAL_TOKEN_BALANCES_CONCURRENCY` | Concurrency for archival token balances fetcher. Implemented in [#8167](https://github.com/blockscout/blockscout/pull/8167). | Version: v10.0.0\+ <br />Default: `10` <br />Applications: Indexer |
Expand Down Expand Up @@ -521,21 +522,21 @@
## CSV Export

<Info>
When `CSV_EXPORT_ASYNC_ENABLED` is `true`, supported CSV export endpoints create a tracked request, enqueue a background job, write the CSV to a temporary file, upload it to Gokapi, and return a `request_id` for polling instead of streaming the CSV directly in the HTTP response.

Check warning on line 525 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L525

Did you really mean 'Gokapi'?
</Info>

| Variable | Description | Parameters |
| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `CSV_EXPORT_LIMIT` | Changes the max number of rows pulled by the CSV export logic. Applies to both sync and async CSV export paths. Implemented in [#10497](https://github.com/blockscout/blockscout/pull/10497) | Version: v6.8.0\+ <br />Default: `10000` <br />Applications: API |
| `CSV_EXPORT_ASYNC_ENABLED` | Enables async CSV export for supported endpoints. When enabled, the API returns `202 Accepted` with a `request_id` and processes exports through Oban instead of streaming them directly. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `false` <br />Applications: API |

Check warning on line 531 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L531

Did you really mean 'Oban'?
| `CSV_EXPORT_ASYNC_OBAN_CONCURRENCY` | Sets Oban concurrency for the `csv_export` queue used by async CSV exports. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `10` <br />Applications: API |

Check warning on line 532 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L532

Did you really mean 'Oban'?
| `CSV_EXPORT_ASYNC_GOKAPI_URL` | Base URL of the Gokapi instance used to store completed async CSV exports. Trailing slash is stripped during validation. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: Yes, if async export is enabled <br />Default: (empty) <br />Applications: API |

Check warning on line 533 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L533

Did you really mean 'Gokapi'?
| `CSV_EXPORT_ASYNC_GOKAPI_API_KEY` | API key sent to Gokapi in the `apikey` header for async CSV export uploads. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: Yes, if async export is enabled <br />Default: (empty) <br />Applications: API |

Check warning on line 534 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L534

Did you really mean 'Gokapi'?
| `CSV_EXPORT_ASYNC_MAX_PENDING_TASKS_PER_IP` | Maximum number of pending async CSV export requests allowed per client IP at once. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `3` <br />Applications: API |
| `CSV_EXPORT_ASYNC_UPLOAD_CHUNK_SIZE` | Chunk size in bytes for reading the generated CSV file and uploading it to Gokapi. Should be synchronized with Gokapi settings. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `47185920` <br />Applications: API |

Check warning on line 536 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L536

Did you really mean 'Gokapi'?

Check warning on line 536 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L536

Did you really mean 'Gokapi'?
| `CSV_EXPORT_DB_TIMEOUT` | Timeout for CSV export database work. Follows the [time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `1h` if async export is enabled, otherwise `5m` <br />Applications: API |
| `CSV_EXPORT_ASYNC_TMP_DIR` | Directory used for in-progress async CSV export files before they are uploaded to Gokapi. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `/tmp/csv_export` <br />Applications: API |

Check warning on line 538 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L538

Did you really mean 'Gokapi'?
| `CSV_EXPORT_ASYNC_GOKAPI_TIMEOUT` | HTTP timeout and `recv_timeout` used for Gokapi requests during async CSV export. Follows the [time format](/setup/env-variables/backend-env-variables#time-format). Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `60s` <br />Applications: API |

Check warning on line 539 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L539

Did you really mean 'Gokapi'?
| `CSV_EXPORT_ASYNC_GOKAPI_UPLOAD_EXPIRY_DAYS` | Sets Gokapi `expiryDays` for completed async CSV export uploads. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `1` <br />Applications: API |
| `CSV_EXPORT_ASYNC_GOKAPI_UPLOAD_ALLOWED_DOWNLOADS` | Sets Gokapi `allowedDownloads` for completed async CSV export uploads. Implemented in [#14028](https://github.com/blockscout/blockscout/pull/14028) | Version: v11.0.0\+ Required: No <br />Default: `1` <br />Applications: API |

Expand Down Expand Up @@ -582,7 +583,7 @@
| `API_RATE_LIMIT_REMOTE_IP_KNOWN_PROXIES` | Comma separated list of trusted proxy IP addresses or CIDR ranges that are allowed to set the client IP headers for rate limiting. Implemented in [#12386](https://github.com/blockscout/blockscout/pull/13082) | Version: v9.1.0\+ <br />Default: `(empty)` <br />Applications: API |
| `ETH_JSON_RPC_MAX_BATCH_SIZE` | Max batch size for Eth JSON RPC requests. Implemented in [#9409](https://github.com/blockscout/blockscout/pull/9409) | Version: v6.3.0\+ <br />Default: `5` <br />Applications: API |
| `API_RATE_LIMIT_HAMMER_REDIS_SSL_ENABLED` | If `true` Blockscout will use SSL to connect to Redis DB for Hammer rate limit library. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: master <br />Default: (empty) <br />Applications: API |
| `API_RATE_LIMIT_HAMMER_REDIS_SENTINEL_URLS` | List of Redis sentinel urls for Hammer rate limit library. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: master <br />Default: (empty) <br />Applications: API |

Check warning on line 586 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L586

Did you really mean 'urls'?
| `API_RATE_LIMIT_HAMMER_REDIS_SENTINEL_MASTER_NAME`| Sentinel master name for Hammer rate limit library. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: master <br />Default: (empty) <br />Applications: API |

## General application rate Limits
Expand All @@ -596,7 +597,7 @@
| `RATE_LIMITER_ON_DEMAND_MAX_BAN_INTERVAL` | Max time an IP address can be banned from on-demand fetcher calls. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `1h` <br />Applications: API |
| `RATE_LIMITER_ON_DEMAND_LIMITATION_PERIOD` | Time after which the number of bans for the IP address will be reset. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `1h` <br />Applications: API |
| `RATE_LIMITER_REDIS_SSL_ENABLED` | If `true` Blockscout will use SSL to connect to Redis DB for rate limiter. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: master <br />Default: (empty) <br />Applications: API |
| `RATE_LIMITER_REDIS_SENTINEL_URLS` | List of Redis sentinel urls for rate limiter. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: master <br />Default: (empty) <br />Applications: API |

Check warning on line 600 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L600

Did you really mean 'urls'?
| `RATE_LIMITER_REDIS_SENTINEL_MASTER_NAME` | Sentinel master name for rate limiter. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901) | Version: master <br />Default: (empty) <br />Applications: API |

## GraphQL API
Expand Down Expand Up @@ -645,7 +646,7 @@
| `ACCOUNT_KEYCLOAK_CLIENT_SECRET` | [Keycloak](https://www.keycloak.org/) client secret. Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0\+, v9.4.0\+ <br />Default: (empty) <br />Applications: API |
| `ACCOUNT_KEYCLOAK_EMAIL_WEBHOOK_URL` | URL address where new email users are reported. Implemented in [#14068](https://github.com/blockscout/blockscout/pull/14068). | Version: v10.1.0\+, v9.4.0\+ <br />Default: (empty) <br />Applications: API |
| `ACCOUNT_REDIS_SSL_ENABLED` | If `true` Blockscout will use SSL to connect to Account Redis DB. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901). | Version: master <br />Default: (empty) <br />Applications: API |
| `ACCOUNT_REDIS_SENTINEL_URLS` | List of Account Redis sentinel urls. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901). | Version: master <br />Default: (empty) <br />Applications: API |

Check warning on line 649 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L649

Did you really mean 'urls'?
| `ACCOUNT_REDIS_SENTINEL_MASTER_NAME` | Account Sentinel master name. Implemented in [#13901](https://github.com/blockscout/blockscout/pull/13901). | Version: master <br />Default: (empty) <br />Applications: API |

## Specific Smart Contracts
Expand Down