forgejo/docs/content/doc/packages/container.en-us.md

date	title	slug	draft	toc	menu
2021-07-20T00:00:00+00:00	Container Registry	packages/container	false	false	sidebar parent name weight identifier packages Container Registry 30 container

Container Registry

Publish Open Container Initiative compliant images for your user or organization. The container registry follows the OCI specs and supports all compatible images like Docker and Helm Charts.

Table of Contents

{{< toc >}}

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:

docker login gitea.example.com

Image naming convention

Images must follow this naming convention:

{registry}/{owner}/{image}

For example, these are all valid image names for the owner testuser:

gitea.example.com/testuser/myimage

gitea.example.com/testuser/my-image

gitea.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:

docker push gitea.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:

docker push gitea.example.com/testuser/myimage:latest

Pull an image

Pull an image by executing the following command:

docker pull gitea.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:

docker pull gitea.example.com/testuser/myimage:latest