git diff abe8fe352711601fbcd24bf4505f7e0b81a93c5d..d3982bcd814bac93e3cbce1c7eb749b17e413fbd -- $(find . -type f -name '*en-us*')
4.7 KiB
title | license | origin_url |
---|---|---|
Alpine Packages Repository | Apache-2.0 | d3982bcd81/docs/content/usage/packages/alpine.en-us.md |
Publish Alpine packages for your user or organization.
Requirements
To work with the Alpine registry, you need to use a HTTP client like curl
to upload and a package manager like apk
to consume packages.
The following examples use apk
.
Configuring the package registry
To register the Alpine registry add the url to the list of known apk sources (/etc/apk/repositories
):
https://forgejo.example.com/api/packages/{owner}/alpine/<branch>/<repository>
Placeholder | Description |
---|---|
owner |
The owner of the packages. |
branch |
The branch to use. |
repository |
The repository to use. |
If the registry is private, provide credentials in the url. You can use a password or a personal access token:
https://{username}:{your_password_or_token}@forgejo.example.com/api/packages/{owner}/alpine/<branch>/<repository>
The Alpine registry files are signed with a RSA key which must be known to apk. Download the public key and store it in /etc/apk/keys/
:
curl -JO https://forgejo.example.com/api/packages/{owner}/alpine/key
Afterwards update the local package index:
apk update
Publish a package
To publish an Alpine package (*.apk
), perform a HTTP PUT
operation with the package content in the request body.
PUT https://forgejo.example.com/api/packages/{owner}/alpine/{branch}/{repository}
Parameter | Description |
---|---|
owner |
The owner of the package. |
branch |
The branch may match the release version of the OS, ex: v3.17 . |
repository |
The repository 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.apk \
https://forgejo.example.com/api/packages/testuser/alpine/v3.17/main
If you are using 2FA or OAuth use a personal access token instead of the password.
You cannot publish a file with the same name twice to a package. You must delete the existing package file 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 name, version, branch, repository or architecture are invalid. |
409 Conflict |
A package file with the same combination of parameters exist already in the package. |
Delete a package
To delete an Alpine 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}/alpine/{branch}/{repository}/{architecture}/{filename}
Parameter | Description |
---|---|
owner |
The owner of the package. |
branch |
The branch to use. |
repository |
The repository to use. |
architecture |
The package architecture. |
filename |
The file to delete. |
Example request using HTTP Basic authentication:
curl --user your_username:your_token_or_password -X DELETE \
https://forgejo.example.com/api/packages/testuser/alpine/v3.17/main/test-package-1.0.0.apk
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 Alpine registry, execute the following commands:
# use latest version
apk add {package_name}
# use specific version
apk add {package_name}={package_version}