1
0
mirror of synced 2025-12-23 11:54:18 -05:00
Files
docs/content/packages/guides/about-github-container-registry.md
Melanie Yarbrough 91d3857341 [DO NOT MERGE] Universe 2020 Day 1: December 8, 2020 (#16480)
* Update README

* [Universe] Dark mode (#16545)

* Dark mode updates (#16696)

* [Universe] Corporate sponsors (#16457)

* Dependency review beta (#16563)

* Add placeholder topic file

* Revert change I didn't make

I'm not sure where this change came from or why it's showing up in my PR here but I didn't make this change and it's not part of Dependency Review so I'm reverting it.

* Un-revert previous change

OK I see what happened there. I was comparing the PR to main rather than the Universe megabranch, hence it showed a change I didn't make.
This commit undoes the change I do not want to revert on the megabranch.

* Update image to add the Checks tab

* Finish updating topic to mention DR

* Fix check errors

* Fix another versioning error

* Add a sentence about supported ecosystems

* Add review changes

* Remove Further reading topics in same category

As suggested by James, I've removed the links to topics that are in the same `/collaborating-with-issues-and-pull-requests/` category as this topic.

* Update content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md

Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>

* Update content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md

Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>

* Update content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md

Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>

* Update content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md

* Updates in the light of Maya's review

* Remove use of "exploit" in description

* Change 'dependency review summary' to 'dependency review'

See PR review comment from Maya.

* Mention that the age of the dependency is given

* Update screenshots to latest GUI

* Add details of dependency ordering within a DR

* Update content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md

Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>

* Update content/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies.md

Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>

* Update content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md

Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>

Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>

* [Universe 2020] New audit log REST API endpoint (#16699)

* Minimal updates for preview

*  API previews 

* Update beta note

*  Update API previews 

*  Update previews 

* Add draft section for git events

* Clean API previews

* More fixes + API previews

* Address review comments + update API previews

* Mention cursor-based pagination

* Update content/rest/overview/resources-in-the-rest-api.md

Co-authored-by: Jeff Saracco <jeffsaracco@github.com>

* Temporarily revert API previews

* Small tweaks from review comments + API previews

* revert json schemas

* Updating OpenAPI descriptions (#16776)

* Updating OpenAPI descriptions

* Add decorated OpenAPI schema files

Co-authored-by: Jeff Saracco <jeffsaracco@github.com>
Co-authored-by: skedwards88 <skedwards88@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>

* [Universe 2020] GitHub Actions: Workflow visualization (#16629)

* initial empty commit

* replace image used only for dotcom

* add new image and version usage

* add new image and version usage

* add new image and version usage

* add new image and version usage, delete unneeded image

* add new image and version usage, fix incorrect image

* add new image and version usage

* add new image and version usage

* add new image and version usage

* add new image and version usage

* update screenshot update

* add new image and version usage

* add new image and version usage

* update text

* update images and fix list numbering

* add step with graph

* Add missing versioning

* add overview of visualization

* fix title to match filename

* add beta note

* update wording

* Restructuring packages (#16731)

* restructuring packages

* moving more content

* moving more content

* fixing the toc for guides

* removing CR from the landing page

* adjusting qs

* updating npm

* enhancing guides

* Update updating-github-insights.md

* fixing link problems

* fixing link problems

* redirecting the redirects

* another change

* fixing the guides landing page

* add packages quickstart

* moving CR content

* adding some descriptive text

* add packages landing page

* adding guide content back

* update popular articles based on data

* fix caps on product name

* try removing product from front matter

* Update content/packages/quickstart.md

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* Update content/packages/quickstart.md

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* add node package instructions to quickstart

* fixing links and adding redirect

* fixing redirects

* renaming to container guides

* renaming to container guides and fixing reusables

* adding context and about section to CR

* removign landign page extra titles and descriptions

* reverting the packages

* updating link

* Apply suggestions from code review

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* updating

* update test to reflect redesigned product landing page

* Add private vs public clarification

* Fix borked test

* filter out standalone category files from test

Co-authored-by: Cynthia Rich <crichID@github.com>
Co-authored-by: Cynthia Rich <crichID@users.noreply.github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
Co-authored-by: Jason Etcovitch <jasonetco@github.com>

* Add discussions video
See https://github.com/github/docs-internal/pull/16759

* Remove typos

* update article name in test

Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com>
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: Jeff Saracco <jeffsaracco@github.com>
Co-authored-by: skedwards88 <skedwards88@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Cynthia Rich <crichID@github.com>
Co-authored-by: Cynthia Rich <crichID@users.noreply.github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
Co-authored-by: Jason Etcovitch <jasonetco@github.com>
2020-12-08 12:20:02 -05:00

7.2 KiB

title, intro, product, redirect_from, versions
title intro product redirect_from versions
About GitHub Container Registry You can use {% data variables.product.prodname_github_container_registry %} to seamlessly host and manage Docker container images in your organization or personal user account on {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_github_container_registry %} allows you to configure who can manage and access packages using fine-grained permissions. {% data reusables.gated-features.packages %}
/packages/getting-started-with-github-container-registry/about-github-container-registry
/packages/managing-container-images-with-github-container-registry
free-pro-team
*

{% note %}

Note: {% data variables.product.prodname_github_container_registry %} is currently in public beta and subject to change. During the beta, storage and bandwidth are free. To use {% data variables.product.prodname_github_container_registry %}, you must enable the feature for your account. For more information, see "Enabling improved container support."

{% endnote %}

About {% data variables.product.prodname_github_container_registry %}

{% data reusables.package_registry.container-registry-feature-highlights %}

To share context about your package's use, you can link a repository to your container image on {% data variables.product.prodname_dotcom %}. For more information, see "Connecting a repository to a container image."

{% data variables.product.prodname_github_container_registry %} has different hosting locations, permission, and visibility than other package registries.

Package registries {% data variables.product.prodname_github_container_registry %}
Hosting locations You can host multiple packages in one repository. You can host multiple container images in one organization or user account.
Permissions Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.
For each container image, you can choose the access level that others have. The permissions for container image access are separate from your organization and repository permissions.
Visibility {% data reusables.package_registry.public-or-private-packages %} You can set the visibility of each of your container images. A private container image is only visible to people and teams who are given access within your organization. A public container image is visible to anyone.
Anonymous access N/A You can access public container images anonymously.

For more information, see "About scopes and permissions for {% data variables.product.prodname_github_container_registry %}."

Supported formats

The {% data variables.product.prodname_container_registry %} currently supports the following container image formats:

The {% data variables.product.prodname_github_container_registry %} hosts containers at ghcr.io/OWNER/IMAGE-NAME.

Package client Language Package format Description
Docker CLI N/A Dockerfile Docker container support.

Manifest Lists/Image Indexes

{% data variables.product.prodname_github_container_registry %} also supports Docker Manifest List/OCI Image Index formats which are defined in the Docker V2, Schema 2 and OCI image specifications.

Visibility and access permissions for container images

If you have admin permissions to a container image, you can set the container image to private or public. Public images allow anonymous access and can be pulled without authentication or signing in via the CLI.

As an admin, you can also grant access permissions for a container image that are separate from the permissions you've set at the organization and repository levels.

For container images published and owned by a user account, you can give any person an access role. For container images published and owned by an organization, you can give any person or team in the organization an access role.

Permission role Access description
Read Can download package.
Can read package metadata.
Write Can upload and download this package.
Can read and write package metadata.
Admin Can upload, download, delete, and manage this package.
Can read and write package metadata.
Can grant package permissions.

For more information, see "Configuring access control and visibility for container images."

About scopes and permissions for {% data variables.product.prodname_github_container_registry %}

To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your user account must have appropriate permissions for that repository.

Scope Description
read:packages Download and install container images from {% data variables.product.prodname_github_container_registry %}
write:packages Upload and publish container images to {% data variables.product.prodname_github_container_registry %}
delete:packages Delete specified versions of private or public container images from {% data variables.product.prodname_github_container_registry %}. For more information, see "Deleting a container image."

To learn about available scopes and permissions for container images, see "Configuring access control and visibility for container images."

For more information, see "Creating a personal access token" and "Available scopes."

About billing for {% data variables.product.prodname_github_container_registry %}

{% data reusables.package_registry.billing-for-container-registry %}

Contacting support

If you have feedback or feature requests for {% data variables.product.prodname_github_container_registry %}, use the feedback form.

Contact {% data variables.contact.github_support %} about {% data variables.product.prodname_github_container_registry %} using our contact form if:

  • You experience anything that contradicts the documentation.
  • You encounter vague or unclear errors.
  • Your published package contains sensitive data, such as GDPR violations, API Keys, or personally-identifying information.