diff --git a/README.md b/README.md index c9dc7e3..112174a 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ - [How to use `docker-credential-magic`](#how-to-use-docker-credential-magic) - [Local setup](#local-setup) - [How to use `docker-credential-magician`](#how-to-use-docker-credential-magician) + - [Including a subset of helpers](#including-a-subset-of-helpers) + - [Using custom mappings and/or helpers](#using-custom-mappings-andor-helpers) - [Go library](#go-library) - [Project history](#project-history) - [Contributing](#contributing) @@ -161,6 +163,45 @@ DOCKER_CONFIG=/opt/magic {"credsStore":"magic"} ``` +If the `-t` / `--tag` flag is not provided, `magician` will default to +publishing the image back to its original location (overwriting the existing tag). + +#### Including a subset of helpers + +You may specify the `-i` / `--include` flag (one or more times) to +limit the helpers that are added to the image. + +For example, to only include the `azure` and `gcp` helpers: + +``` +$ docker-credential-magician mutate example.com/myimage:1.2.3 \ + -i azure -i gcp +``` + +Note: These each must match one of the supported helpers found in the +[mappings/](./mappings/) directory. + +#### Using custom mappings and/or helpers + +In some scenarios, you may wish to supply a custom directory of mappings, +for example to add extra domains. Or, you may wish to supply a custom +directory of helper binaries, if you need to use a different version of +a helper, or add your own. + +For these cases, you can use the following flags: + +- `--mappings-dir ` +- `--helpers-dir ` + +Please note that all mappings and helpers must be provided (as in, `magician` will +not automatically resolve any missing binaries in ``). + +In addition, all helpers in `` must be built for +a Linux amd64 architecture. + +Lastly, the `magic` helper will *always* be sourced from +the one baked-in to `magician`. + #### Go library You may wish to make use of `magician` functionality in your Go application.