-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: georgi-l95 <glazarov95@gmail.com>
- Loading branch information
1 parent
5f5a689
commit d835eb6
Showing
3 changed files
with
107 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,78 @@ | ||
# Server Configuration | ||
|
||
The components of the Hedera Block Node all support loading configuration via the | ||
environment. | ||
The components of the Hedera Block Node all support loading configuration via the environment. | ||
|
||
## Default Values | ||
|
||
The default configuration allows users to quickly get up and running without having to configure anything. This provides | ||
ease of use at the trade-off of some insecure default configuration. Most configuration settings have appropriate | ||
defaults and can be left unchanged. It is recommended to browse the properties below and adjust to your needs. | ||
|
||
| Environment Variable | Description | Default Value | | ||
|:---|:---|---:| | ||
| PERSISTENCE_STORAGE_LIVE_ROOT_PATH | The root path for the live storage. | | | ||
| PERSISTENCE_STORAGE_ARCHIVE_ROOT_PATH | The root path for the archive storage. | | | ||
| PERSISTENCE_STORAGE_TYPE | Type of the persistence storage | BLOCK_AS_LOCAL_FILE | | ||
| CONSUMER_TIMEOUT_THRESHOLD_MILLIS | Time to wait for subscribers before disconnecting in milliseconds | 1500 | | ||
| SERVICE_DELAY_MILLIS | Service shutdown delay in milliseconds | 500 | | ||
| MEDIATOR_RING_BUFFER_SIZE | Size of the ring buffer used by the mediator (must be a power of 2) | 67108864 | | ||
| NOTIFIER_RING_BUFFER_SIZE | Size of the ring buffer used by the notifier (must be a power of 2) | 2048 | | ||
| SERVER_PORT | The port the server will listen on | 8080 | | ||
| SERVER_MAX_MESSAGE_SIZE_BYTES | The maximum size of a message frame in bytes | 1048576 | | ||
## ConsumerConfig | ||
|
||
Uses the prefix `consumer` so all properties should start with `consumer.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :----------------------- | :---------------------------------- | :---------------------------------------------------------------- | ------------: | | ||
| `timeoutThresholdMillis` | `CONSUMER_TIMEOUT_THRESHOLD_MILLIS` | Time to wait for subscribers before disconnecting in milliseconds | 1500 | | ||
|
||
## PersistenceConfig | ||
|
||
Uses the prefix `persistence.storage` so all properties should start with `persistence.storage.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :---------------- | :-------------------------------------- | :------------------------------------ | --------------------: | | ||
| `liveRootPath` | `PERSISTENCE_STORAGE_LIVE_ROOT_PATH` | The root path for the live storage | - | | ||
| `archiveRootPath` | `PERSISTENCE_STORAGE_ARCHIVE_ROOT_PATH` | The root path for the archive storage | - | | ||
| `type` | `PERSISTENCE_STORAGE_TYPE` | Type of the persistence storage | `BLOCK_AS_LOCAL_FILE` | | ||
|
||
## ServiceConfig | ||
|
||
Uses the prefix `service` so all properties should start with `service.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :------------ | :--------------------- | :------------------------------------- | ------------: | | ||
| `delayMillis` | `SERVICE_DELAY_MILLIS` | Service shutdown delay in milliseconds | 500 | | ||
|
||
## MediatorConfig | ||
|
||
Uses the prefix `mediator` so all properties should start with `mediator.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :--------------- | :-------------------------- | :------------------------------------------------------------------ | ------------: | | ||
| `ringBufferSize` | `MEDIATOR_RING_BUFFER_SIZE` | Size of the ring buffer used by the mediator (must be a power of 2) | 67108864 | | ||
| `type` | `MEDIATOR_TYPE` | Type of the mediator | - | | ||
|
||
## NotifierConfig | ||
|
||
Uses the prefix `notifier` so all properties should start with `notifier.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :--------------- | :-------------------------- | :------------------------------------------------------------------ | ------------: | | ||
| `ringBufferSize` | `NOTIFIER_RING_BUFFER_SIZE` | Size of the ring buffer used by the notifier (must be a power of 2) | 2048 | | ||
|
||
## ProducerConfig | ||
|
||
Uses the prefix `producer` so all properties should start with `producer.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :----- | :------------------- | :------------------- | ------------: | | ||
| `type` | `PRODUCER_TYPE` | Type of the producer | - | | ||
|
||
## ServerConfig | ||
|
||
Uses the prefix `server` so all properties should start with `server.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :-------------------- | :------------------------------ | :------------------------------------------- | ------------: | | ||
| `maxMessageSizeBytes` | `SERVER_MAX_MESSAGE_SIZE_BYTES` | The maximum size of a message frame in bytes | 1048576 | | ||
| `port` | `SERVER_PORT` | The port the server will listen on | 8080 | | ||
|
||
## PrometheusConfig | ||
|
||
Uses the prefix `prometheus` so all properties should start with `prometheus.` | ||
|
||
| Key | Environment Variable | Description | Default Value | | ||
| :------------------- | :-------------------------------- | :------------------------------------------ | ------------: | | ||
| `endpointEnabled` | `PROMETHEUS_ENDPOINT_ENABLED` | Whether the Prometheus endpoint is enabled | - | | ||
| `endpointPortNumber` | `PROMETHEUS_ENDPOINT_PORT_NUMBER` | The port number for the Prometheus endpoint | - | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters