Skip to content

Commit 9926397

Browse files
authored
docs: updates the environment variables (#463)
* update Environment variables * Update env-vars.md * Update env-vars.md
1 parent df4bb96 commit 9926397

File tree

1 file changed

+67
-37
lines changed

1 file changed

+67
-37
lines changed

docs/docs/install-and-deploy/env-vars.md

Lines changed: 67 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,40 +13,70 @@ Within root folder of the project there are example `.env` files, which can be c
1313
- `.env.IntegrationTest` - Is used for integration tests with yaci devkit
1414
- `.env.docker-compose` - Is used for standard docker-compose setup (Copy this file and adjusted it to your needs)
1515

16-
| Variable | Description | Default |
17-
| ---------------------------- | ---------------------------- | ------------------------------------- |
18-
| `LOG` | Log level | INFO |
19-
| `NETWORK` | Network | mainnet |
20-
| `MITHRIL_SYNC` | Sync from Mithril snapshot | true |
21-
| `PROTOCOL_MAGIC` | Cardano protocol magic | 764824073 |
22-
| `DB_IMAGE_NAME` | Postgres docker image name | postgres |
23-
| `DB_IMAGE_TAG` | Postgres docker image tag | 14.11-bullseye |
24-
| `DB_NAME` | Postgres database | rosetta-java |
25-
| `DB_USER` | Postgres admin user | rosetta_db_admin |
26-
| `DB_SECRET` | Postgres admin secret | weakpwd#123_d |
27-
| `DB_HOST` | Postgres host | db |
28-
| `DB_PORT` | Postgres port | 5432 |
29-
| `DB_SCHEMA` | Database schema | mainnet |
30-
| `DB_PATH` | Database path | /data |
31-
| `CARDANO_NODE_HOST` | Cardano node host | cardano-node |
32-
| `CARDANO_NODE_PORT` | Cardano node port | 3001 |
33-
| `CARDANO_NODE_VERSION` | Cardano node version | 8.9.2 |
34-
| `CARDANO_NODE_SUBMIT_HOST` | Cardano node submit api host | cardano-submit-api |
35-
| `NODE_SUBMIT_API_PORT` | Cardano node submit api port | 8090 |
36-
| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket path | /node |
37-
| `CARDANO_NODE_SOCKET` | Cardano node socket file | /node/node.socket |
38-
| `CARDANO_NODE_DB` | Cardano node db path | /node/db |
39-
| `CARDANO_CONFIG` | Cardano node config path | /config/mainnet |
40-
| `API_DOCKER_IMAGE_TAG` | Docker Tag for API Image | main |
41-
| `API_SPRING_PROFILES_ACTIVE` | Api spring profile | staging |
42-
| `API_PORT` | Rosetta api exposed port | 8082 |
43-
| `ROSETTA_VERSION` | Rosetta version | 1.4.13 |
44-
| `TOPOLOGY_FILEPATH` | Topology file path | ./config/mainnet/topology.json |
45-
| `GENESIS_SHELLEY_PATH` | Genesis file path | ./config/mainnet/shelley-genesis.json |
46-
| `GENESIS_BYRON_PATH` | Genesis file path | ./config/mainnet/byron-genesis.json |
47-
| `GENESIS_ALONZO_PATH ` | Genesis file path | ./config/mainnet/alonzo-genesis.json |
48-
| `GENESIS_CONWAY_PATH` | Genesis file path | ./config/mainnet/conway-genesis.json |
49-
| `INDEXER_DOCKER_IMAGE_TAG` | Yaci indexer Docker version | main |
50-
| `PRUNING_ENABLED` | If pruning should be enabled | true |
51-
| `YACI_SPRING_PROFILES` | Yaci indexer spring profile | postgres |
52-
| `DEVKIT_ENABLED` | Devkit enabled | false |
16+
| Variable | Description | Default | Notes |
17+
|-----------------------------------------|-----------------------------------------------------|---------------------------------------|----------------------------|
18+
| `LOG` | Log level | INFO | added in release 1.0.0 |
19+
| `NETWORK` | Network | mainnet | added in release 1.0.0 |
20+
| `MITHRIL_SYNC` | Sync from Mithril snapshot | true | added in release 1.0.0 |
21+
| `PROTOCOL_MAGIC` | Cardano protocol magic | 764824073 | added in release 1.0.0 |
22+
| `DB_IMAGE_NAME` | Postgres docker image name | postgres | added in release 1.0.0 |
23+
| `DB_IMAGE_TAG` | Postgres docker image tag | 14.11-bullseye | added in release 1.0.0 |
24+
| `DB_NAME` | Postgres database | rosetta-java | added in release 1.0.0 |
25+
| `DB_USER` | Postgres admin user | rosetta_db_admin | added in release 1.0.0 |
26+
| `DB_SECRET` | Postgres admin secret | weakpwd#123_d | added in release 1.0.0 |
27+
| `DB_HOST` | Postgres host | db | added in release 1.0.0 |
28+
| `DB_PORT` | Postgres port | 5432 | added in release 1.0.0 |
29+
| `DB_SCHEMA` | Database schema | mainnet | added in release 1.0.0 |
30+
| `DB_PATH` | Database path | /data | added in release 1.0.0 |
31+
| `CARDANO_NODE_HOST` | Cardano node host | cardano-node | added in release 1.0.0 |
32+
| `CARDANO_NODE_PORT` | Cardano node port | 3001 | added in release 1.0.0 |
33+
| `CARDANO_NODE_VERSION` | Cardano node version | 8.9.2 | added in release 1.0.0 |
34+
| `CARDANO_NODE_SUBMIT_HOST` | Cardano node submit API host | cardano-submit-api | added in release 1.0.0 |
35+
| `NODE_SUBMIT_API_PORT` | Cardano node submit API port | 8090 | added in release 1.0.0 |
36+
| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket path | /node | added in release 1.0.0 |
37+
| `CARDANO_NODE_SOCKET` | Cardano node socket file | /node/node.socket | added in release 1.0.0 |
38+
| `CARDANO_NODE_DB` | Cardano node db path | /node/db | added in release 1.0.0 |
39+
| `CARDANO_CONFIG` | Cardano node config path | /config/mainnet | added in release 1.0.0 |
40+
| `API_DOCKER_IMAGE_TAG` | Docker Tag for API Image | main | added in release 1.0.0 |
41+
| `API_SPRING_PROFILES_ACTIVE` | API spring profile | staging | added in release 1.0.0 |
42+
| `API_PORT` | Rosetta API exposed port | 8082 | added in release 1.0.0 |
43+
| `ROSETTA_VERSION` | Rosetta version | 1.4.13 | added in release 1.0.0 |
44+
| `TOPOLOGY_FILEPATH` | Topology file path | ./config/mainnet/topology.json | added in release 1.0.0 |
45+
| `GENESIS_SHELLEY_PATH` | Genesis file path | ./config/mainnet/shelley-genesis.json | added in release 1.0.0 |
46+
| `GENESIS_BYRON_PATH` | Genesis file path | ./config/mainnet/byron-genesis.json | added in release 1.0.0 |
47+
| `GENESIS_ALONZO_PATH` | Genesis file path | ./config/mainnet/alonzo-genesis.json | added in release 1.0.0 |
48+
| `GENESIS_CONWAY_PATH` | Genesis file path | ./config/mainnet/conway-genesis.json | added in release 1.0.0 |
49+
| `INDEXER_DOCKER_IMAGE_TAG` | Yaci indexer Docker version | main | added in release 1.0.0 |
50+
| `PRUNING_ENABLED` | If pruning should be enabled | false | added in release 1.0.0 |
51+
| `PRUNING_INTERVAL` | The pruning interval in seconds | 600 | added in release 1.2.4 |
52+
| `PRUNING_SAFE_BLOCKS` | Number of safe blocks to keep in the store | 2160 | added in release 1.2.4 |
53+
| `YACI_SPRING_PROFILES` | Yaci indexer spring profile | postgres | added in release 1.0.0 |
54+
| `DEVKIT_ENABLED` | Devkit enabled | false | added in release 1.0.0 |
55+
| `YACI_HTTP_BASE_URL` | Yaci Indexer's URL | http://yaci-indexer:9095/api/v1 | added in release 1.2.1 |
56+
| `YACI_INDEXER_PORT` | Yaci Indexer's port | 9095 | added in release 1.2.1 |
57+
| `HTTP_CONNECT_TIMEOUT_SECONDS` | Yaci connection timeout in seconds | 5 | added in release 1.2.1 |
58+
| `HTTP_REQUEST_TIMEOUT_SECONDS` | Yaci request timeout in seconds | 5 | added in release 1.2.1 |
59+
| `API_DB_POOL_MIN_COUNT` | Minimum number of connections API↔DB | 12 | added in release 1.2.5 |
60+
| `API_DB_POOL_MAX_COUNT` | Maximum number of connections API↔DB | 12 | added in release 1.2.5 |
61+
| `API_DB_POOL_MAX_LIFETIME_MS` | Description | 2000000 | added in release 1.2.5 |
62+
| `API_DB_POOL_CONNECTION_TIMEOUT_MS` | Connection timeout in milliseconds | 100000 | added in release 1.2.5 |
63+
| `API_DB_KEEP_ALIVE_MS` | Keep alive in milliseconds | 60000 | added in release 1.2.5 |
64+
| `API_DB_LEAK_CONNECTIONS_WARNING_MS` | Leak connection warning threshold (ms) | 60000 | added in release 1.2.5 |
65+
| `API_DB_MONITOR_PERFORMANCE` | Monitor performance enable? | false | added in release 1.2.5 |
66+
| `DB_POSTGRES_MAX_CONNECTIONS` | Maximum concurrent database connections | 300 (mid-level profile) | added in release 1.2.6 |
67+
| `DB_POSTGRES_SHARED_BUFFERS` | Memory for caching | 4GB (mid-level profile) | added in release 1.2.6 |
68+
| `DB_POSTGRES_EFFECTIVE_CACHE_SIZE` | Disk cache size | 8GB (mid-level profile) | added in release 1.2.6 |
69+
| `DB_POSTGRES_WORK_MEM` | Memory per operation for query processing | 64MB (mid-level profile) | added in release 1.2.6 |
70+
| `DB_POSTGRES_MAINTENANCE_WORK_MEM` | Memory for maintenance tasks like index creation | 512GB (mid-level profile) | added in release 1.2.6 |
71+
| `DB_POSTGRES_WAL_BUFFERS` | Write-ahead log buffer memory | 512MB (mid-level profile) | added in release 1.2.6 |
72+
| `DB_POSTGRES_CHECKPOINT_COMPLETION_TARGET` | Target checkpoint completion | 0.7 (mid-level profile) | added in release 1.2.6 |
73+
| `DB_POSTGRES_RANDOM_PAGE_COST` | Cost estimate for random disk page access | 1.3 (mid-level profile) | added in release 1.2.6 |
74+
| `DB_POSTGRES_EFFECTIVE_IO_CONCURRENCY` | Concurrent I/O for table scans | 2 (mid-level profile) | added in release 1.2.6 |
75+
| `DB_POSTGRES_PARALLEL_TUPLE_COST` | Cost per tuple in parallel queries | 0.05 (mid-level profile) | added in release 1.2.6 |
76+
| `DB_POSTGRES_PARALLEL_SETUP_COST` | Cost for initiating parallel query workers | 500 (mid-level profile) | added in release 1.2.6 |
77+
| `DB_POSTGRES_MAX_PARALLEL_WORKERS_PER_GATHER` | Parallel workers per query | 4 (mid-level profile) | added in release 1.2.6 |
78+
| `DB_POSTGRES_MAX_PARALLEL_WORKERS` | Total parallel workers across all queries | 8 (mid-level profile) | added in release 1.2.6 |
79+
| `DB_POSTGRES_SEQ_PAGE_COST` | Cost estimate for sequential disk page access | 1.0 | added in release 1.2.6 |
80+
| `DB_POSTGRES_JIT` | Just-In-Time compilation setting | off | added in release 1.2.6 |
81+
| `DB_POSTGRES_BGWRITER_LRU_MAXPAGES` | Max pages for background writer per cycle | 100 (mid-level profile) | added in release 1.2.6 |
82+
| `DB_POSTGRES_BGWRITER_DELAY` | Delay between background writer cycles | 200ms (mid-level profile) | added in release 1.2.6 |

0 commit comments

Comments
 (0)