From 2ca4650e4f29133eda95c4e744dad6f39cac881d Mon Sep 17 00:00:00 2001 From: Jesse Schmidt Date: Thu, 26 Sep 2024 10:00:24 -0700 Subject: [PATCH] fix readme --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 456c230..43b8649 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,20 @@ asvec --help etc. ## Configuration File -All connection related command-line flags are available +All connection related command-line flags can also be configured using a +configuration file. By default, the configuration file is installed at +`/etc/aerospike/asvec.yml`. Asvec checks for the existence of `asvec.yml` in +both `/etc/aerospike` and the current working directory. If your configuration +file is elsewhere use the `--config-file` flag. -asvec.yml: -``` +To support multi-cluster scenarios the configuration file requires nesting keys +under the `cluster-name`. By default, when a configuration file is loaded the +`default` cluster name is used. To use a cluster-name other than `default` use +the `--cluster-name` flag. + +Example asvec.yml: + +```yaml default: host: 127.0.0.1:5000 credentials: admin:admin