notkshitij/docker-credential-helpers
1
0
Fork 0
mirror of https://github.com/docker/docker-credential-helpers.git synced 2026-06-13 16:01:28 +05:30
Code Releases 1 Activity

Merge pull request #233 from thaJeztah/update_readme_instructions

Browse Source 
Update local build instructions in README
This commit is contained in:
Sebastiaan van Stijn
2022-08-21 16:16:39 +02:00
committed by GitHub
parent 6dfcfc15aa becf2f2a95
commit a9d6be0a41
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -8
View File
@@ -19,35 +19,42 @@ You can build the credential helpers using Docker:
```shell ```shell
# create builder # create builder
$ docker buildx create --use $ docker buildx create --use
# build credential helpers from remote repository and output to ./bin/build # build credential helpers from remote repository and output to ./bin/build
$ docker buildx bake "https://github.com/docker/docker-credential-helpers.git" $ docker buildx bake "https://github.com/docker/docker-credential-helpers.git"
# or from local source # or from local source
$ git clone https://github.com/docker/docker-credential-helpers.git $ git clone https://github.com/docker/docker-credential-helpers.git
$ cd docker-credential-helpers
$ docker buildx bake $ docker buildx bake
``` ```
Or if the toolchain is already installed on your machine: Or if the toolchain is already installed on your machine:
1 - Download the source and put it in your `$GOPATH` with `go get`. 1 - Download the source.
``` ```shell
$ go get github.com/docker/docker-credential-helpers $ git clone https://github.com/docker/docker-credential-helpers.git
$ cd docker-credential-helpers
``` ```
2 - Use `make` to build the program you want. That will leave an executable in the `bin` directory inside the repository. 2 - Use `make` to build the program you want. That will leave an executable in the `bin` directory inside the repository.
``` ```shell
$ cd $GOPATH/docker/docker-credentials-helpers
$ make osxkeychain $ make osxkeychain
``` ```
3 - Put that binary in your `$PATH`, so Docker can find it. 3 - Put that binary in your `$PATH`, so Docker can find it.
```shell
$ cp bin/docker-credential-osxkeychain /usr/local/bin/
```
## Usage ## Usage
### With the Docker Engine ### With the Docker Engine
Set the `credsStore` option in your `.docker/config.json` file with the suffix of the program you want to use. For instance, set it to `osxkeychain` if you want to use `docker-credential-osxkeychain`. Set the `credsStore` option in your `~/.docker/config.json` file with the suffix of the program you want to use. For instance, set it to `osxkeychain` if you want to use `docker-credential-osxkeychain`.
```json ```json
{ {
@@ -91,8 +98,8 @@ A credential helper can be any program that can read values from the standard in
This repository also includes libraries to implement new credentials programs in Go. Adding a new helper program is pretty easy. You can see how the OS X keychain helper works in the [osxkeychain](osxkeychain) directory. This repository also includes libraries to implement new credentials programs in Go. Adding a new helper program is pretty easy. You can see how the OS X keychain helper works in the [osxkeychain](osxkeychain) directory.
1. Implement the interface `credentials.Helper` in `YOUR_PACKAGE/YOUR_PACKAGE_$GOOS.go` 1. Implement the interface `credentials.Helper` in `YOUR_PACKAGE/`
2. Create a main program in `YOUR_PACKAGE/cmd/main_$GOOS.go`. 2. Create a main program in `YOUR_PACKAGE/cmd/`.
3. Add make tasks to build your program and run tests. 3. Add make tasks to build your program and run tests.
## License ## License