mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-12-10 20:44:45 -05:00
79 lines
2 KiB
Markdown
79 lines
2 KiB
Markdown
|
---
|
||
|
|
layout: '~/layouts/Markdown.astro'
|
||
|
|
title: 'Container Registry'
|
||
|
|
---
|
||
|
|
|
||
|
|
Publish [Open Container Initiative](https://opencontainers.org/) compliant images for your user or organization.
|
||
|
|
The container registry follows the OCI specs and supports all compatible images like [Docker](https://www.docker.com/) and [Helm Charts](https://helm.sh/).
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
To work with the Container registry, you can use the tools for your specific image type.
|
||
|
|
The following examples use the `docker` client.
|
||
|
|
|
||
|
|
## Login to the container registry
|
||
|
|
|
||
|
|
To push an image or if the image is in a private registry, you have to authenticate:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
docker login forgejo.example.com
|
||
|
|
```
|
||
|
|
|
||
|
|
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||
|
|
|
||
|
|
## Image naming convention
|
||
|
|
|
||
|
|
Images must follow this naming convention:
|
||
|
|
|
||
|
|
`{registry}/{owner}/{image}`
|
||
|
|
|
||
|
|
For example, these are all valid image names for the owner `testuser`:
|
||
|
|
|
||
|
|
`forgejo.example.com/testuser/myimage`
|
||
|
|
|
||
|
|
`forgejo.example.com/testuser/my-image`
|
||
|
|
|
||
|
|
`forgejo.example.com/testuser/my/image`
|
||
|
|
|
||
|
|
**NOTE:** The registry only supports case-insensitive tag names. So `image:tag` and `image:Tag` get treated as the same image and tag.
|
||
|
|
|
||
|
|
## Push an image
|
||
|
|
|
||
|
|
Push an image by executing the following command:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
docker push forgejo.example.com/{owner}/{image}:{tag}
|
||
|
|
```
|
||
|
|
|
||
|
|
| Parameter | Description |
|
||
|
|
| ----------| ----------- |
|
||
|
|
| `owner` | The owner of the image. |
|
||
|
|
| `image` | The name of the image. |
|
||
|
|
| `tag` | The tag of the image. |
|
||
|
|
|
||
|
|
For example:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
docker push forgejo.example.com/testuser/myimage:latest
|
||
|
|
```
|
||
|
|
|
||
|
|
## Pull an image
|
||
|
|
|
||
|
|
Pull an image by executing the following command:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
docker pull forgejo.example.com/{owner}/{image}:{tag}
|
||
|
|
```
|
||
|
|
|
||
|
|
| Parameter | Description |
|
||
|
|
| ----------| ----------- |
|
||
|
|
| `owner` | The owner of the image. |
|
||
|
|
| `image` | The name of the image. |
|
||
|
|
| `tag` | The tag of the image. |
|
||
|
|
|
||
|
|
For example:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
docker pull forgejo.example.com/testuser/myimage:latest
|
||
|
|
```
|