Skip to content

Commit a843ac6

Browse files
fr33m0nkfr33m0nk
committed
Add details of new configurations to README
1 parent 38c5368 commit a843ac6

File tree

1 file changed

+41
-30
lines changed

1 file changed

+41
-30
lines changed

‎README.md

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -21,36 +21,47 @@
2121

2222
## Container environment variables
2323

24-
| Environment variable | Applies to `RUN_MODE` | Supported values | Default value |
25-
|--------------------------|:-----------------------------------------------------------|:---------------------------------------------------------------------------------|----------------------------|
26-
| RUN_MODE | Starts Datomic as Transactor or Peer | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `LIST_BACKUPS`, `VERIFY_BACKUP`, `RESTORE_DB` | `TRANSACTOR` |
27-
| TRANSACTOR_HOST | `TRANSACTOR` | | `localhost` |
28-
| TRANSACTOR_PORT | `TRANSACTOR` | | `4334` |
29-
| MEMORY_INDEX_THRESHOLD | `TRANSACTOR` | | `32m` |
30-
| MEMORY_INDEX_MAX | `TRANSACTOR` | | `512m` |
31-
| OBJECT_CACHE_MAX | `TRANSACTOR` | | `1g` |
32-
| MEMCACHED_HOST | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
33-
| MEMCACHED_AUTO_DISCOVERY | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
34-
| MEMCACHED_USERNAME | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
35-
| MEMCACHED_PASSWORD | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
36-
| VALCACHE_PATH | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
37-
| VALCACHE_MAX_GB | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
38-
| XMS | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `4g` |
39-
| XMX | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `4g` |
40-
| LOG_LEVEL | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `INFO` |
41-
| PG_PORT | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `5432` |
42-
| PG_HOST | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
43-
| PG_USER | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
44-
| PG_PASSWORD | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
45-
| PG_DATABASE | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
46-
| PEER_HOST | `PEER` | | `localhost` |
47-
| PEER_PORT | `PEER` | | `8998` |
48-
| PEER_ACCESSKEY | `PEER` | | `myaccesskey` |
49-
| PEER_SECRET | `PEER` | | `mysecret` |
50-
| DATOMIC_DB_NAME | `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
51-
| BACKUP_S3_BUCKET_URI | `BACKUP_DB`, `LIST_BACKUPS`, `VERIFY_BACKUP`, `RESTORE_DB` | | **None, provided by user** |
52-
| VERIFY_ALL_SEGMENTS | `VERIFY_BACKUP` | `true` or `false` | `true` |
53-
| BACKUP_TIME_IN_LONG | `VERIFY_BACKUP`, `RESTORE_DB` (optional) | | **None, provided by user** |
24+
| Environment variable | Applies to `RUN_MODE` | Supported values | Default value |
25+
|-------------------------------------|:-----------------------------------------------------------|:---------------------------------------------------------------------------------|----------------------------|
26+
| RUN_MODE | Starts Datomic as Transactor or Peer | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `LIST_BACKUPS`, `VERIFY_BACKUP`, `RESTORE_DB` | `TRANSACTOR` |
27+
| TRANSACTOR_HOST | `TRANSACTOR` | | `0.0.0.0` |
28+
| TRANSACTOR_ALT_HOST | `TRANSACTOR` | | `127.0.0.1` |
29+
| TRANSACTOR_PORT | `TRANSACTOR` | | `4334` |
30+
| TRANSACTOR_HEALTHCHECK_PORT | `TRANSACTOR` | | `9999` |
31+
| TRANSACTOR_HEALTHCHECK_CONCURRENCY | `TRANSACTOR` | | `6` |
32+
| TRANSACTOR_HEARTBEAT_INTERVAL_IN_MS | `TRANSACTOR` | | `5000` |
33+
| TRANSACTOR_ENCRYPT_CHANNEL | `TRANSACTOR` | | `true` |
34+
| TRANSACTOR_WRITE_CONCURRENCY | `TRANSACTOR` | | `4` |
35+
| TRANSACTOR_READ_CONCURRENCY | `TRANSACTOR` | | `8` |
36+
| MEMORY_INDEX_THRESHOLD | `TRANSACTOR` | | `32m` |
37+
| MEMORY_INDEX_MAX | `TRANSACTOR` | | `512m` |
38+
| OBJECT_CACHE_MAX | `TRANSACTOR` | | `1g` |
39+
| MEMCACHED_HOST | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
40+
| MEMCACHED_PORT | `TRANSACTOR` (optional), `PEER` (optional) | | `11211` |
41+
| MEMCACHED_CONFIG_TIMEOUT_IN_MS | `TRANSACTOR` (optional), `PEER` (optional) | | `100` |
42+
| MEMCACHED_AUTO_DISCOVERY | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
43+
| MEMCACHED_USERNAME | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
44+
| MEMCACHED_PASSWORD | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
45+
| VALCACHE_PATH | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
46+
| VALCACHE_MAX_GB | `TRANSACTOR` (optional), `PEER` (optional) | | **None, provided by user** |
47+
| XMS | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `4g` |
48+
| XMX | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `4g` |
49+
| LOG_LEVEL | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `INFO` |
50+
| PG_PORT | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | `5432` |
51+
| PG_HOST | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
52+
| PG_USER | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
53+
| PG_PASSWORD | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
54+
| PG_DATABASE | `TRANSACTOR`, `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
55+
| PEER_HOST | `PEER` | | `0.0.0.0` |
56+
| PEER_PORT | `PEER` | | `8998` |
57+
| PEER_ACCESSKEY | `PEER` | | `myaccesskey` |
58+
| PEER_SECRET | `PEER` | | `mysecret` |
59+
| PEER_TX_TIMEOUT_IN_MS | `PEER` | | `10000` |
60+
| PEER_READ_CONCURRENCY | `PEER` | | `8` |
61+
| DATOMIC_DB_NAME | `PEER`, `BACKUP_DB`, `RESTORE_DB` | | **None, provided by user** |
62+
| BACKUP_S3_BUCKET_URI | `BACKUP_DB`, `LIST_BACKUPS`, `VERIFY_BACKUP`, `RESTORE_DB` | | **None, provided by user** |
63+
| VERIFY_ALL_SEGMENTS | `VERIFY_BACKUP` | `true` or `false` | `true` |
64+
| BACKUP_TIME_IN_LONG | `VERIFY_BACKUP`, `RESTORE_DB` (optional) | | **None, provided by user** |
5465

5566

5667
### [Official Datomic deployment docs](https://docs.datomic.com/pro/operation/deployment.html)

0 commit comments

Comments
 (0)