Skip to content

Commit

Permalink
docs(config): update env handling descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
indirection42 committed Apr 23, 2024
1 parent 1d1a561 commit fc8c2b2
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ This is a generalized JSON RPC proxy server with features specifically designed

Pull vendors: `git submodule update --init --recursive`

Quick start: `cargo run -- --config config.yml`
Quick start: `cargo run -- --config configs/config.yml`

This will run a proxy server with [config.yml](config.yml) as the configuration file.
This will run a proxy server with [config.yml](configs/config.yml) as the configuration file.

Run with `RUSTFLAGS="--cfg tokio_unstable"` to enable [tokio-console](https://github.com/tokio-rs/console)

Expand All @@ -24,7 +24,11 @@ Run with `RUSTFLAGS="--cfg tokio_unstable"` to enable [tokio-console](https://gi
- Log format. Default: `full`.
- Options: `full`, `pretty`, `json`, `compact`

In addition, you can refer env variables in `config.yml` by using `${SOME_ENV}`
In addition, you can refer env variables in `config.yml` by using following syntax:

- `${variable}`
- `${variable:-word}` indicates that if variable is set then the result will be that value. If variable is not set then word will be the result. or
- `${variable:+word}` indicates that if variable is set then word will be the result, otherwise the result is the empty string.

## Features

Expand Down

0 comments on commit fc8c2b2

Please sign in to comment.