Skip to content

Commit

Permalink
Adding new configuration documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vgmello committed Aug 28, 2024
1 parent d3f279d commit 3a26b36
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -132,6 +139,10 @@ environments:
hostname: test.endpoint
template: orders_db
...

# config:
# copy_to_clipboard: true
# aws_ignore_configured_endpoints: true
```

## Support
Expand Down

0 comments on commit 3a26b36

Please sign in to comment.