magic_rb/forgejo
Template
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo synced 2024-11-30 05:46:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
forgejo/docs/content/doc/usage/packages/container.en-us.md
John Olheiser bb25f85ce8
Refactor docs (#23752) 
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00

2.2 KiB
Raw Blame History

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