diff --git a/plugins/secretstores/os/README.md b/plugins/secretstores/os/README.md index 659e0d6c7..883782ce6 100644 --- a/plugins/secretstores/os/README.md +++ b/plugins/secretstores/os/README.md @@ -45,8 +45,8 @@ are assumed to be static and are only read once at startup of Telegraf. ## * macOS: keyring specifies the macOS' Keychain name and collection is an ## optional Keychain service name ## * Windows: keys follow a fixed pattern in the form - ## `::`. Please keep this in mind when creating - ## secrets with the Windows credential tool. + ## `::`. Please keep this in mind when + ## creating secrets with the Windows credential tool. # keyring = "telegraf" # collection = "" @@ -75,11 +75,21 @@ If `password` is omitted, you will be prompted for the password on startup. ### Windows -On Windows you can use the Credential Manager Control panel or +On Windows you can use the Credential Manager in the Control Panel or [Telegraf](../../../cmd/telegraf/README.md) to manage your secrets. -Please use _generic credentials_ and respect the special -`::` format of the secret key. The -secret value needs to be stored in the `Password` field. + +If using the Credential Manager, click "Windows Credentials" and then +"Add a generic credential" with the following: + +* _Internet or network address_: Enter the secret name in the format of: + `::` +* _User name_: Use `telegraf`. This field is not used, but needs something + entered. +* _Password_: The actual secret value + +If using Telegraf, see the help output of `telegraf secrets set` to add +secrets. Again use the `::` format of the secret +key name. ### Docker diff --git a/plugins/secretstores/os/sample.conf b/plugins/secretstores/os/sample.conf index 2e3ae2ab5..b603de0df 100644 --- a/plugins/secretstores/os/sample.conf +++ b/plugins/secretstores/os/sample.conf @@ -10,8 +10,8 @@ ## * macOS: keyring specifies the macOS' Keychain name and collection is an ## optional Keychain service name ## * Windows: keys follow a fixed pattern in the form - ## `::`. Please keep this in mind when creating - ## secrets with the Windows credential tool. + ## `::`. Please keep this in mind when + ## creating secrets with the Windows credential tool. # keyring = "telegraf" # collection = ""