> For the complete documentation index, see [llms.txt](https://chameleoncloud.gitbook.io/chi-edge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://chameleoncloud.gitbook.io/chi-edge/getting-started/using-private-registries.md).

# Using Private Registries

This guide will show you how to setup and use a private registry with CHI\@Edge. This allows you to use a private image behind authentication.

In order to setup a private registry, you first must add the registry and credentials to via the CLI. 

Install the Openstack Zun client 

```
pip install python-zunclient
```

Next, you will need to download the OpenRC file from the CHI\@Edge site. This process is the same as from the main Chameleon sites, and is documented [here](https://chameleoncloud.readthedocs.io/en/latest/technical/cli.html#the-openstack-rc-script). After sourcing this file, run the following command:

```
openstack appcontainer registry create \
    --username USERNAME \
    --password PASSWORD \
    --domain DOMAIN
```

The domain here should be the domain used when tagging your image. For example, Docker Hub would use the domain `registry.hub.docker.com`.

After the registry is setup, you can use CHI\@Edge as normal. To use a private image, include the domain in the image name, for example `registry.hub.docker.com/mppowers/my_private_image`. This will then automatically load your stored credentials for the matching domain before the container is created, and use them to pull the image.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://chameleoncloud.gitbook.io/chi-edge/getting-started/using-private-registries.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.