mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-12-01 19:17:12 -05:00
ae97171f57
git log --patch faa28b5a44912f1c63afddab9396bae9e6fe061c..8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd . ':(glob)docs/**/*.en-us.md'
(cherry picked from commit b77359bfb1)
81 lines
2.3 KiB
Markdown
81 lines
2.3 KiB
Markdown
---
|
|
title: 'Container Registry'
|
|
license: 'Apache-2.0'
|
|
origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/container.en-us.md'
|
|
---
|
|
|
|
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](../../api-usage/#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
|
|
```
|
|
|
|
For more information please check the [docker push](https://docs.docker.com/engine/reference/commandline/push/) documentation page.
|
|
|
|
## 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
|
|
```
|