Skip to content

Commit e7ea298

Browse files
Doc updates, config file
1 parent db86581 commit e7ea298

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,10 @@ Run a Backup
104104

105105
**Using a Config File**
106106

107+
The tool supports a YAML-based config file for settings. The config file is loaded first and any additional command-line arguments override the file based config values.
108+
109+
An example *(with comments)* of the YAML-based config file is here: `conf/mongodb-consistent-backup.example.conf <conf/mongodb-consistent-backup.example.conf>`__. All available config values are also listed by passing the '--help' fag to the tool.
110+
107111
::
108112

109113
$ mongodb-consistent-backup --config /etc/mongodb-consistent-backup.yml

0 commit comments

Comments
 (0)