(container-registry:github)=

# GitHub Container Registry

[GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#about-the-container-registry) provides a container registry for hosting Docker container images within your personal or organizational GitHub account.  The container registry serves as a public-facing package source providing self-managed docker images.   

## Register Container Registry

Obtain the Container Registry Information with the following steps:
 
1. To authenticate, you'll need to generate a [GitHub personal access token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). When generating the personal access token, ensure that you select a minimum of the following scopes:
* `read:packages`
* `write:packages`: If you want to upload the package to login_server, please provide the necessary permissions.
2. Make sure that you note down one of the passwords shown on the screen.
3. Define the following:

* <b>login_server</b>: `ghcr.io/<NAMESPACE>`
* <b>username</b>: GitHub username
* <b>password</b>: GitHub PAT

```{note}
Replace NAMESPACE with the name of the personal account or organization to which you want the image to be scoped.
```
4. Proceed to [CLI command](cli-container-registry-register) to register the container registry.