This repository has been archived on 2023-02-13. You can view files and clone it, but cannot push or open issues or pull requests.
docs/content/doc/packages/overview.en-us.md
Bradley D. Thornton 12d8377c8c Update overview.en-us.md (#22463)
Fix grammar
2023-01-16 16:24:24 -06:00

3.9 KiB

date title slug draft toc menu
2021-07-20T00:00:00+00:00 Package Registry packages/overview false false
sidebar
parent name weight identifier
packages Overview 1 overview

Package Registry

Starting with Gitea 1.17, the Package Registry can be used as a public or private registry for common package managers.

Table of Contents

{{< toc >}}

Supported package managers

The following package managers are currently supported:

Name Language Package client
[Composer]({{< relref "doc/packages/composer.en-us.md" >}}) PHP composer
[Conan]({{< relref "doc/packages/conan.en-us.md" >}}) C++ conan
[Container]({{< relref "doc/packages/container.en-us.md" >}}) - any OCI compliant client
[Generic]({{< relref "doc/packages/generic.en-us.md" >}}) - any HTTP client
[Helm]({{< relref "doc/packages/helm.en-us.md" >}}) - any HTTP client, cm-push
[Maven]({{< relref "doc/packages/maven.en-us.md" >}}) Java mvn, gradle
[npm]({{< relref "doc/packages/npm.en-us.md" >}}) JavaScript npm, yarn, pnpm
[NuGet]({{< relref "doc/packages/nuget.en-us.md" >}}) .NET nuget
[Pub]({{< relref "doc/packages/pub.en-us.md" >}}) Dart dart, flutter
[PyPI]({{< relref "doc/packages/pypi.en-us.md" >}}) Python pip, twine
[RubyGems]({{< relref "doc/packages/rubygems.en-us.md" >}}) Ruby gem, Bundler
[Vagrant]({{< relref "doc/packages/vagrant.en-us.md" >}}) - vagrant

The following paragraphs only apply if Packages are not globally disabled!

Repository-Packages

A package always belongs to an owner (a user or organisation), not a repository. To link an (already uploaded) package to a repository, open the settings page on that package and choose a repository to link this package to. The entire package will be linked, not just a single version.

Linking a package results in showing that package in the repository's package list, and shows a link to the repository on the package site (as well as a link to the repository issues).

Access Restrictions

Package owner type User Organization
read access public, if user is public too; otherwise for this user only public, if org is public, otherwise for org members only
write access owner only org members with admin or write access to the org

N.B.: These access restrictions are subject to change, where more finegrained control will be added via a dedicated organization team permission.

Create or upload a package

Depending on the type of package, use the respective package-manager for that. Check out the sub-page of a specific package manager for instructions.

View packages

You can view the packages of a repository on the repository page.

  1. Go to the repository.
  2. Go to Packages in the navigation bar.

To view more details about a package, select the name of the package.

Download a package

To download a package from your repository:

  1. Go to Packages in the navigation bar.
  2. Select the name of the package to view the details.
  3. In the Assets section, select the name of the package file you want to download.

Delete a package

You cannot edit a package after you have published it in the Package Registry. Instead, you must delete and recreate it.

To delete a package from your repository:

  1. Go to Packages in the navigation bar.
  2. Select the name of the package to view the details.
  3. Click Delete package to permanently delete the package.

Disable the Package Registry

The Package Registry is automatically enabled. To disable it for a single repository:

  1. Go to Settings in the navigation bar.
  2. Disable Enable Repository Packages Registry.

Previously published packages are not deleted by disabling the Package Registry.