Skip to content

Commit

Permalink
Update RegistryAuthentication.md
Browse files Browse the repository at this point in the history
  • Loading branch information
baronfel authored Nov 27, 2023
1 parent ffdc3fb commit bb45436
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/RegistryAuthentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Interacting with private container registries requires authenticating with those registries.

Docker has established a pattern with this via the [`docker login`](https://docs.docker.com/engine/reference/commandline/login/) command, which is a way of interacting with a Docker config file that contains rules for authenticating with specific registries. This file, and the authentication types it encodes, are supported by Microsoft.Net.Build.Containers for registry authentication. This should ensure that this package works seamlessly with any registry you can `docker pull` from and `docker push`.
Docker has established a pattern with this via the [`docker login`](https://docs.docker.com/engine/reference/commandline/login/) command, which is a way of interacting with a Docker config file that contains rules for authenticating with specific registries. This file, and the authentication types it encodes, are supported by Microsoft.Net.Build.Containers for registry authentication. This should ensure that this package works seamlessly with any registry you can `docker pull` from and `docker push`. This file is normally stored at `~/.docker/config.json`, but it can be specified additionally through the `DOCKER_CONFIG` variable, which points to a directory containing a `config.json` file.

## Kinds of authentication

Expand Down Expand Up @@ -30,7 +30,7 @@ The `credsStore` section is a single string property whose value is the name of
In some scenarios the standard Docker authentication mechanism described above just doesn't cut it. This tooling has an additional mechanism for providing credentials to registries: environment variables. If environment variables are used, the credential provide mechanism will not be used at all. The following environment variables are supported:

* SDK_CONTAINER_REGISTRY_UNAME
* This should be the username for the registry. If the password for the registry is a token, then the username should be "<token>".
* This should be the username for the registry. If the password for the registry is a token, then the username should be `"<token>"`.
* SDK_CONTAINER_REGISTRY_PWORD
* This should be the password, token, etc for the registry.

Expand Down

0 comments on commit bb45436

Please sign in to comment.