From 5be80ca212be264d202ec6675eb8ad1f9c872b29 Mon Sep 17 00:00:00 2001 From: Nassim 'Nass' Eddequiouaq Date: Mon, 28 Aug 2017 18:10:08 +0200 Subject: [PATCH] Add instructions for pass helper configuration Signed-off-by: Nassim 'Nass' Eddequiouaq --- CHANGELOG.md | 5 +++++ README.md | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ad5ab00d..2a9aeffc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,11 @@ The platform released is identified after the tag name. - New entry point for passing environment variables when calling a credential helper - Add a Makefile rule generating a Windows release binary +### Note + +`pass` needs to be configured for `docker-credential-pass` to work properly. +It must be initialized with a `gpg2` key ID. Make sure your GPG key exists is in `gpg2` keyring as `pass` uses `gpg2` instead of the regular `gpg`. + ## v0.5.2 (Mac OS X, Windows, Linux) - Add a `version` command to output the version diff --git a/README.md b/README.md index e795f7c5..f9cbc3fb 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,12 @@ You can see examples of each function in the [client](https://godoc.org/github.c 1. osxkeychain: Provides a helper to use the OS X keychain as credentials store. 2. secretservice: Provides a helper to use the D-Bus secret service as credentials store. 3. wincred: Provides a helper to use Windows credentials manager as store. +4. pass: Provides a helper to use `pass` as credentials store. + +#### Note + +`pass` needs to be configured for `docker-credential-pass` to work properly. +It must be initialized with a `gpg2` key ID. Make sure your GPG key exists is in `gpg2` keyring as `pass` uses `gpg2` instead of the regular `gpg`. ## Development