0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00
forgejo-docs/docs/user/packages/debian.md
Earl Warren 6aa9b491a0 sync with Gitea e865de1e9d65dc09797d165a51c8e705d2a86030
cd docs
git diff d3982bcd814bac93e3cbce1c7eb749b17e413fbd..e865de1e9d65dc09797d165a51c8e705d2a86030 -- $(find . -type f -name '*en-us*')
2024-04-23 07:16:10 +00:00

4.8 KiB

title license origin_url
Debian Package Registry Apache-2.0 e865de1e9d/docs/content/usage/packages/debian.en-us.md

Publish Debian packages for your user or organization.

Requirements

To work with the Debian registry, you need to use a HTTP client like curl to upload and a package manager like apt to consume packages.

The following examples use apt.

Configuring the package registry

To register the Debian registry add the url to the list of known apt sources:

echo "deb [signed-by=/etc/apt/keyrings/forgejo-{owner}.asc] https://forgejo.example.com/api/packages/{owner}/debian {distribution} {component}" | sudo tee -a /etc/apt/sources.list.d/forgejo.list
Placeholder Description
owner The owner of the package.
distribution The distribution to use.
component The component to use.

If the registry is private, provide credentials in the url. You can use a password or a personal access token:

echo "deb [signed-by=/etc/apt/keyrings/forgejo-{owner}.asc] https://{username}:{your_password_or_token}@forgejo.example.com/api/packages/{owner}/debian {distribution} {component}" | sudo tee -a /etc/apt/sources.list.d/forgejo.list

The Debian registry files are signed with a PGP key which must be known to apt:

sudo curl https://forgejo.example.com/api/packages/{owner}/debian/repository.key -o /etc/apt/keyrings/forgejo-{owner}.asc

Afterwards update the local package index:

apt update

Publish a package

To publish a Debian package (*.deb), perform a HTTP PUT operation with the package content in the request body.

PUT https://forgejo.example.com/api/packages/{owner}/debian/pool/{distribution}/{component}/upload
Parameter Description
owner The owner of the package.
distribution The distribution may match the release name of the OS, ex: bionic.
component The component can be used to group packages or just main or similar.

Example request using HTTP Basic authentication:

curl --user your_username:your_password_or_token \
     --upload-file path/to/file.deb \
     https://forgejo.example.com/api/packages/testuser/debian/pool/bionic/main/upload

If you are using 2FA or OAuth use a personal access token instead of the password.

You cannot publish a package if a package of the same name, version, distribution, component and architecture already exists. You must delete the existing package 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 exists already.

Delete a package

To delete a Debian package perform a HTTP DELETE operation. This will delete the package version too if there is no file left.

DELETE https://forgejo.example.com/api/packages/{owner}/debian/pool/{distribution}/{component}/{package_name}/{package_version}/{architecture}
Parameter Description
owner The owner of the package.
package_name The package name.
package_version The package version.
distribution The package distribution.
component The package component.
architecture The package architecture.

Example request using HTTP Basic authentication:

curl --user your_username:your_token_or_password -X DELETE \
     https://forgejo.example.com/api/packages/testuser/debian/pools/bionic/main/test-package/1.0.0/amd64

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 Debian registry, execute the following commands:

# use latest version
apt install {package_name}
# use specific version
apt install {package_name}={package_version}