mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-11-02 23:41:05 +00:00 
			
		
		
		
	This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
		
			
				
	
	
		
			114 lines
		
	
	
	
		
			3.4 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			114 lines
		
	
	
	
		
			3.4 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
---
 | 
						|
date: "2023-03-08T00:00:00+00:00"
 | 
						|
title: "RPM Package Registry"
 | 
						|
slug: "rpm"
 | 
						|
draft: false
 | 
						|
toc: false
 | 
						|
menu:
 | 
						|
  sidebar:
 | 
						|
    parent: "packages"
 | 
						|
    name: "RPM"
 | 
						|
    sidebar_position: 105
 | 
						|
    identifier: "rpm"
 | 
						|
---
 | 
						|
 | 
						|
# RPM Package Registry
 | 
						|
 | 
						|
Publish [RPM](https://rpm.org/) packages for your user or organization.
 | 
						|
 | 
						|
## Requirements
 | 
						|
 | 
						|
To work with the RPM registry, you need to use a package manager like `yum`, `dnf` or `zypper` to consume packages.
 | 
						|
 | 
						|
The following examples use `dnf`.
 | 
						|
 | 
						|
## Configuring the package registry
 | 
						|
 | 
						|
To register the RPM registry add the url to the list of known apt sources:
 | 
						|
 | 
						|
```shell
 | 
						|
dnf config-manager --add-repo https://gitea.example.com/api/packages/{owner}/rpm.repo
 | 
						|
```
 | 
						|
 | 
						|
| Placeholder | Description |
 | 
						|
| ----------- | ----------- |
 | 
						|
| `owner`     | The owner of the package. |
 | 
						|
 | 
						|
If the registry is private, provide credentials in the url. You can use a password or a [personal access token](development/api-usage.md#authentication):
 | 
						|
 | 
						|
```shell
 | 
						|
dnf config-manager --add-repo https://{username}:{your_password_or_token}@gitea.example.com/api/packages/{owner}/rpm.repo
 | 
						|
```
 | 
						|
 | 
						|
You have to add the credentials to the urls in the `rpm.repo` file in `/etc/yum.repos.d` too.
 | 
						|
 | 
						|
## Publish a package
 | 
						|
 | 
						|
To publish a RPM package (`*.rpm`), perform a HTTP PUT operation with the package content in the request body.
 | 
						|
 | 
						|
```
 | 
						|
PUT https://gitea.example.com/api/packages/{owner}/rpm/upload
 | 
						|
```
 | 
						|
 | 
						|
| Parameter | Description |
 | 
						|
| --------- | ----------- |
 | 
						|
| `owner`   | The owner of the package. |
 | 
						|
 | 
						|
Example request using HTTP Basic authentication:
 | 
						|
 | 
						|
```shell
 | 
						|
curl --user your_username:your_password_or_token \
 | 
						|
     --upload-file path/to/file.rpm \
 | 
						|
     https://gitea.example.com/api/packages/testuser/rpm/upload
 | 
						|
```
 | 
						|
 | 
						|
If you are using 2FA or OAuth use a [personal access token](development/api-usage.md#authentication) instead of the password.
 | 
						|
You cannot publish a file with the same name twice to a package. You must delete the existing package version first.
 | 
						|
 | 
						|
The server responds with the following HTTP Status codes.
 | 
						|
 | 
						|
| HTTP Status Code  | Meaning |
 | 
						|
| ----------------- | ------- |
 | 
						|
| `201 Created`     | The package has been published. |
 | 
						|
| `400 Bad Request` | The package is invalid. |
 | 
						|
| `409 Conflict`    | A package file with the same combination of parameters exist already in the package. |
 | 
						|
 | 
						|
## Delete a package
 | 
						|
 | 
						|
To delete an RPM package perform a HTTP DELETE operation. This will delete the package version too if there is no file left.
 | 
						|
 | 
						|
```
 | 
						|
DELETE https://gitea.example.com/api/packages/{owner}/rpm/{package_name}/{package_version}/{architecture}
 | 
						|
```
 | 
						|
 | 
						|
| Parameter         | Description |
 | 
						|
| ----------------- | ----------- |
 | 
						|
| `owner`           | The owner of the package. |
 | 
						|
| `package_name`    | The package name. |
 | 
						|
| `package_version` | The package version. |
 | 
						|
| `architecture`    | The package architecture. |
 | 
						|
 | 
						|
Example request using HTTP Basic authentication:
 | 
						|
 | 
						|
```shell
 | 
						|
curl --user your_username:your_token_or_password -X DELETE \
 | 
						|
     https://gitea.example.com/api/packages/testuser/rpm/test-package/1.0.0/x86_64
 | 
						|
```
 | 
						|
 | 
						|
The server responds with the following HTTP Status codes.
 | 
						|
 | 
						|
| HTTP Status Code  | Meaning |
 | 
						|
| ----------------- | ------- |
 | 
						|
| `204 No Content`  | Success |
 | 
						|
| `404 Not Found`   | The package or file was not found. |
 | 
						|
 | 
						|
## Install a package
 | 
						|
 | 
						|
To install a package from the RPM registry, execute the following commands:
 | 
						|
 | 
						|
```shell
 | 
						|
# use latest version
 | 
						|
dnf install {package_name}
 | 
						|
# use specific version
 | 
						|
dnf install {package_name}-{package_version}.{architecture}
 | 
						|
```
 |