diff --git a/README.md b/README.md index f9b32b1..e253864 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,22 @@ Commands: node_tl_has_changed Check if the timeline has changed. ``` +## config file + +All global and service specific parameters can be specified via a config file has follows: + +``` +[options] +endpoints = https://10.20.199.3:8008, https://10.20.199.4:8008,https://10.20.199.5:8008 +cert_file = ./ssl/benoit-dalibo-cert.pem +key_file = ./ssl/benoit-dalibo-key.pem +ca_file = ./ssl/CA-cert.pem +timeout = 0 + +[options.node_is_replica] +lag=100 +``` + ## cluster services ### cluster_config_has_changed diff --git a/doc/make_readme.sh b/doc/make_readme.sh index b1a9cc6..f4f1b33 100755 --- a/doc/make_readme.sh +++ b/doc/make_readme.sh @@ -7,16 +7,34 @@ function readme(){ function helpme(){ readme - readme "\`\`\`" + readme '```' check_patroni $1 --help >> $README - readme "\`\`\`" + readme '```' readme } -cat << _EOF_ > $README +cat << '_EOF_' > $README # check_patroni _EOF_ helpme +cat << '_EOF_' >> $README +## config file + +All global and service specific parameters can be specified via a config file has follows: + +``` +[options] +endpoints = https://10.20.199.3:8008, https://10.20.199.4:8008,https://10.20.199.5:8008 +cert_file = ./ssl/benoit-dalibo-cert.pem +key_file = ./ssl/benoit-dalibo-key.pem +ca_file = ./ssl/CA-cert.pem +timeout = 0 + +[options.node_is_replica] +lag=100 +``` +_EOF_ +readme readme "## cluster services" readme "### cluster_config_has_changed" helpme cluster_config_has_changed