Skip to content

Commit

Permalink
Merge pull request #46 from joao-zanutto/patch-9
Browse files Browse the repository at this point in the history
adjust docs to conform with automatic env var parsing
  • Loading branch information
wwoytenko authored Apr 1, 2024
2 parents 14c8eb1 + 740aa93 commit 38ddf61
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,21 +298,21 @@ scripts:

## Environment variable configuration

It's also possible to configure Greenmask through environment variables.
It's also possible to configure Greenmask through environment variables.

Greenmask will automatically parse any environment variable that matches the configuration in the config file by substituting the dot (`.`) separator for an underscore (`_`) and uppercasing it. As an example, the config file below would apply the same configuration as defining the `LOG_LEVEL=debug` environment variable

```yaml title="config.yaml"
log:
level: debug
```

### Postgres connection variables

Variables used in the `dump` and `restore` commands to configure connection with Postgres database
Additionaly, there are some environment variables exposed by the `dump` and `restore` commands to facilitate the connection configuration with a Postgres database

* `PGHOST` - host used to connect to the postgres database
* `PGPORT` - port where postgres is exposed
* `PGDATABASE` - name of the database to dump/restore
* `PGUSER` - username used to connect to the postgres database
* `PGPASSWORD` - password used to authenticate to the postgres database

### Log configuration variables

Configures Greenmask logging, possible values are described above in the `log` section of this docummentation

* `LOG_FORMAT` - configures log format
* `LOG_LEVEL` - configures log level
* `PGPASSWORD` - password used to authenticate to the postgres database

0 comments on commit 38ddf61

Please sign in to comment.