0
0
mirror of https://github.com/go-gitea/gitea.git synced 2024-11-28 23:36:29 +01:00
gitea/docs/content/doc/packages/container.en-us.md
Lunny Xiao e8433b7fe6
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629)
- **Installation**: includes how to install Gitea and related other
tools, also includes upgrade Gitea
- **Administration**: includes how to configure Gitea, customize Gitea
and manage Gitea instance out of Gitea admin UI
- **Usage**: includes how to use Gitea's functionalities. A sub
documentation is about packages, in future we could also include CI/CD
and others.
- **Development**: includes how to integrate with Gitea's API, how to
develop new features within Gitea
- **Contributing**: includes how to contribute code to Gitea
repositories.

After this is merged, I think we can have a sub-documentation of `Usage`
part named `Actions` to describe how to use Gitea actions

---------

Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-03-23 23:18:24 +08:00

2.2 KiB

date title slug draft toc menu
2021-07-20T00:00:00+00:00 Container Registry usage/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

If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/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:

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