Skip to content

Envs for #13901 #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sl1depengwyn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Envs for #13901 #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 18 additions & 9 deletions setup/env-variables/backend-env-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,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 142 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#L142 

Did you really mean 'clusterization'?

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

View check run for this annotation

Mintlify / Mintlify Validation (blockscout-main) - vale-spellcheck

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

Did you really mean 'clusterization'?

## Database Management

Expand Down Expand Up @@ -562,17 +562,23 @@
| `API_RATE_LIMIT_REMOTE_IP_HEADERS` | Comma separated list of HTTP headers to extract the real client IP address when Blockscout is behind a proxy for rate limiting purposes. Implemented in [#12386](https://github.com/blockscout/blockscout/pull/13082) | Version: v9.1.0\+ <br />Default: `x-forwarded-for` <br />Applications: API |
| `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 566 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#L566 

Did you really mean 'urls'?

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

View check run for this annotation

Mintlify / Mintlify Validation (blockscout-main) - vale-spellcheck

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

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

| Variable | Description | Parameters |
| -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `RATE_LIMITER_REDIS_URL` | Redis DB URL for rate limiter. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: (empty) <br />Applications: API |
| `RATE_LIMITER_ON_DEMAND_TIME_INTERVAL` | Time interval of rate limit for on-demand fetchers. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `5s` <br />Applications: API |
| `RATE_LIMITER_ON_DEMAND_LIMIT_BY_IP` | Rate limit for an IP address for on-demand fetcher call. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `100` <br />Applications: API |
| `RATE_LIMITER_ON_DEMAND_EXPONENTIAL_TIMEOUT_COEFF` | Coefficient to calculate exponential timeout for on-demand rate limit. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `100` <br />Applications: API |
| `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 |
| Variable | Description | Parameters |
| -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `RATE_LIMITER_REDIS_URL` | Redis DB URL for rate limiter. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: (empty) <br />Applications: API |
| `RATE_LIMITER_ON_DEMAND_TIME_INTERVAL` | Time interval of rate limit for on-demand fetchers. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `5s` <br />Applications: API |
| `RATE_LIMITER_ON_DEMAND_LIMIT_BY_IP` | Rate limit for an IP address for on-demand fetcher call. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `100` <br />Applications: API |
| `RATE_LIMITER_ON_DEMAND_EXPONENTIAL_TIMEOUT_COEFF` | Coefficient to calculate exponential timeout for on-demand rate limit. Implemented in [#12218](https://github.com/blockscout/blockscout/pull/12218) | Version: v8.0.0\+ <br />Default: `100` <br />Applications: API |
| `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 580 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#L580 

Did you really mean 'urls'?

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

View check run for this annotation

Mintlify / Mintlify Validation (blockscout-main) - vale-spellcheck

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

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 @@ -612,7 +618,10 @@
| `ACCOUNT_WATCHLIST_NOTIFICATIONS_LIMIT_FOR_30_DAYS` | Per account limit for watch list notifications sent for the last 30 days. Implemented in [#8966](https://github.com/blockscout/blockscout/pull/8966). | Version: v5.3.3\+ <br />Default: `1000` <br />Applications: API |
| `ACCOUNT_OTP_RESEND_INTERVAL` | Time before resending otp email. Implemented in [#10706](https://github.com/blockscout/blockscout/pull/10706). | Version: v6.9.0\+ <br />Default: `1m` <br />Applications: API |
| `ACCOUNT_SIWE_MESSAGE` | Message for Sign In With Ethereum authentication. Implemented in [#11178](https://github.com/blockscout/blockscout/pull/11178). | Version: v6.9.1\+ <br />Default: `Sign in to Blockscout Account V2` <br />Applications: API |
| `ACCOUNT_DYNAMIC_ENV_ID` | Dynamic Environment ID, can be found here https://app.dynamic.xyz/dashboard/developer/api. Implemented in [#13786](https://github.com/blockscout/blockscout/pull/13786). | Version: v10.0.0\+ <br />Default: (empty) <br />Applications: API |
| `ACCOUNT_DYNAMIC_ENV_ID` | Dynamic Environment ID, can be found here https://app.dynamic.xyz/dashboard/developer/api. Implemented in [#13786](https://github.com/blockscout/blockscout/pull/13786). | Version: v10.0.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 623 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#L623 

Did you really mean 'urls'?

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

View check run for this annotation

Mintlify / Mintlify Validation (blockscout-main) - vale-spellcheck

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

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