Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usability update to README.md #596

Merged
merged 3 commits into from
Nov 9, 2023
Merged

Usability update to README.md #596

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
558daee
Usability update to README.md
amosbaker Aug 18, 2023
f10b298
Merge pull request #1 from amosbaker/amosbaker-patch-1
amosbaker Aug 18, 2023
1b0e6db
Merge branch 'awslabs:main' into main
amosbaker Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,25 @@ The Amazon ECR Docker Credential Helper is a
for the Docker daemon that makes it easier to use
[Amazon Elastic Container Registry](https://aws.amazon.com/ecr/).

## Table of Contents
* [Prerequisites](#prerequisites)
* [Installing](#installing)
+ [Amazon Linux 2023 (AL2023)](#amazon-linux-2023-al2023)
+ [Amazon Linux 2 (AL2)](#amazon-linux-2-al2)
+ [Mac OS](#mac-os)
+ [Debian Buster (and future versions)](#debian-buster-and-future-versions)
+ [Ubuntu 19.04 Disco Dingo and newer](#ubuntu-1904-disco-dingo-and-newer)
+ [Arch Linux](#arch-linux)
+ [From Source](#from-source)
* [Configuration](#configuration)
+ [Docker](#docker)
+ [AWS credentials](#aws-credentials)
+ [Amazon ECR Docker Credential Helper](#amazon-ecr-docker-credential-helper-1)
* [Usage](#usage)
* [Troubleshooting](#troubleshooting)
* [Security disclosures](#security-disclosures)
* [License](#license)

## Prerequisites

You must have at least Docker 1.11 installed on your system.
Expand Down Expand Up @@ -158,6 +177,8 @@ Docker to work with the helper.

### Docker

There is no need to use `docker login` or `docker logout`.

Place the `docker-credential-ecr-login` binary on your `PATH` and set the
contents of your `~/.docker/config.json` file to be:

Expand Down