072331ecae
This adds explanations, that were missing regarding Token scopes and the packages feature requiring a token with said scope. Also added a missing explanation, that tokens can be created in the user interface, not just the API. The reason this PR is created was due to misunderstandings around the package feature, that arose during the discussion in https://github.com/go-gitea/gitea/issues/32048 . This PR aims to clarify the misunderstood points around tokens, scopes and the package feature. During the creation of this PR bug https://github.com/go-gitea/gitea/issues/32078 was found, the scopes are always reported as `null` during the response of the initial `POST` to create the token. Co-authored-by: Wladislav ヴラド Artsimovich <wladislav.artsimovich@dmgmori.co.jp> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-on: https://gitea.com/gitea/docs/pulls/72 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: FrostKiwi <frostkiwi@noreply.gitea.com> Co-committed-by: FrostKiwi <frostkiwi@noreply.gitea.com>
4.2 KiB
date, slug, sidebar_position
| date | slug | sidebar_position |
|---|---|---|
| 2021-07-20T00:00:00+00:00 | overview | 1 |
Overview
Starting with Gitea 1.17, the Package Registry can be used as a public or private registry for common package managers.
Supported package managers
The following package managers are currently supported:
| Name | Language | Package client |
|---|---|---|
| Alpine | - | apk |
| Arch | - | pacman |
| Cargo | Rust | cargo |
| Chef | - | knife |
| Composer | PHP | composer |
| Conan | C++ | conan |
| Conda | - | conda |
| Container | - | any OCI compliant client |
| CRAN | R | - |
| Debian | - | apt |
| Generic | - | any HTTP client |
| Go | Go | go |
| Helm | - | any HTTP client, cm-push |
| Maven | Java | mvn, gradle |
| npm | JavaScript | npm, yarn, pnpm |
| NuGet | .NET | nuget |
| Pub | Dart | dart, flutter |
| PyPI | Python | pip, twine |
| RPM | - | yum, dnf, zypper |
| RubyGems | Ruby | gem, Bundler |
| Swift | Swift | swift |
| Vagrant | - | 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 |
Please note, that your respective package manager needs to have a personal access token with the permissions package set to either Read or Read & Write to download and publish packages respectively.
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.
- Go to the repository.
- 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:
- Go to Packages in the navigation bar.
- Select the name of the package to view the details.
- 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:
- Go to Packages in the navigation bar.
- Select the name of the package to view the details.
- 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:
- Go to Settings in the navigation bar.
- Disable Enable Repository Packages Registry.
Previously published packages are not deleted by disabling the Package Registry.