From 3a26b362787bc474ae1ebb40ad63e296c33e5d41 Mon Sep 17 00:00:00 2001 From: Vitor M <4777793+vgmello@users.noreply.github.com> Date: Wed, 28 Aug 2024 01:24:02 +0100 Subject: [PATCH] Adding new configuration documentation --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 58fc116..be58c32 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,13 @@ aws-cred-mgr config - Open user config: `aws-cred-mgr config` - Open AWS credentials file: `aws-cred-mgr config aws` +### Configuration + +The `config` section in the YAML file allows you to set global tool configurations: + +- `copy_to_clipboard`: When set to `true`, the tool will automatically copy generated passwords to the clipboard. Default is `true`. +- `aws_ignore_configured_endpoints`: When set to `true`, the tool will ignore any pre-configured AWS endpoints. This can be useful in certain network environments. Default is `true`. + ## Security Note for Windows and macOS Users On Windows systems, `aws-cred-mgr` securely stores your Okta credentials using the Data Protection API (DPAPI). @@ -132,6 +139,10 @@ environments: hostname: test.endpoint template: orders_db ... + +# config: +# copy_to_clipboard: true +# aws_ignore_configured_endpoints: true ``` ## Support