Skip to content

Commit

Permalink
add documentation about environment variables
Browse files Browse the repository at this point in the history
Signed-off-by: Arne Rutjes <[email protected]>
  • Loading branch information
arner committed Sep 24, 2024
1 parent 795bdc7 commit 63f2c1f
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions docs/core-fabric.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The following example provides descriptions for the various keys required for a
---
# ------------------- Logging section ---------------------------
logging:
# format is same as fabric [<logger>[,<logger>...]=]<level>[:[<logger>[,<logger>...]=]<level>...]
# available loggers: TBD
spec: debug
# format is same as fabric [<logger>[,<logger>...]=]<level>[:[<logger>[,<logger>...]=]<level>...]
format: '%{color}%{time:15:04:05.000} [%{module}] %{shortfunc} %{level:.4s}%{color:reset} %{message}'
spec: debug

# ------------------- FSC Node Configuration -------------------------
fsc:
Expand Down Expand Up @@ -397,6 +397,22 @@ fabric:
addresses:
```
## Overriding configuration keys
Any value that is not a (grand-)child of a list can be overridden with an environment variable that is all uppercase, prefixed with `CORE_`,
and traversing the path in the yaml with underscores. This means that a key like fsc.endpoint.resolvers[0].name cannot be changed via environment variables. Examples:

```sh
CORE_LOGGING_LEVEL=debug
CORE_FSC_P2P_LISTENADDRESS=/ip4/0.0.0.0/tcp/9001
CORE_FSC_IDENTITY_KEY_FILE=/my/private.key
CORE_FSC_KVS_PERSISTENCE_OPTS_DATASOURCE=/mydb.sqlite
CORE_FSC_TRACING_OPTL_ADDRESS=jaeger.example.com:4318
CORE_FABRIC_MYNETWORK_KEEPALIVE_TIMEOUT=120s
```

And so on.

## HSM Support

In order to use a hardware HSM for x.509 identities, you have to build the application with
Expand Down

0 comments on commit 63f2c1f

Please sign in to comment.