Skip to content

Commit

Permalink
Add explantion on how to override config settings with env vars
Browse files Browse the repository at this point in the history
  • Loading branch information
boecklim committed Nov 9, 2023
1 parent b50d798 commit 4abf2d3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ ARC is a transaction processor for Bitcoin that keeps track of the life cycle of
Settings for ARC are defined in a configuration file. The default configuration file is `config.yaml` in the root directory. Each setting is documented in the file itself.
If you want to load `config.yaml` from a different location, you can specify it on the command line using the `-config=<path>` flag.

Each setting in the file `config.yaml` can be overridden with an environment variable. The environment variable needs to have this prefix `ARC_`. A sub setting will be separated using an underscore character. For example the following config setting could be overridden by the environment variable `ARC_METAMORPH_LISTENADDR`
```yaml
metamorph:
listenAddr:
```
## Microservices
To run all the microservices in one process (during development), use the `main.go` file in the root directory.
Expand Down Expand Up @@ -37,7 +43,7 @@ where options are:
-tracer=<true|false>
whether to start the Jaeger tracer (default=false)
-config=<path>
path to config file (default='')
```
Expand Down

0 comments on commit 4abf2d3

Please sign in to comment.