0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-22 22:17:10 -05:00
forgejo-docs/docs/user/packages/conda.md

82 lines
3.6 KiB
Markdown
Raw Normal View History

2023-02-26 18:08:07 -05:00
---
title: 'Conda Package Registry'
2023-03-03 01:44:11 -05:00
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/conda.en-us.md'
2023-02-26 18:08:07 -05:00
---
Publish [Conda](https://docs.conda.io/en/latest/) packages for your user or organization.
## Requirements
To work with the Conda package registry, you need to use [conda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html).
## Configuring the package registry
To register the package registry and provide credentials, edit your `.condarc` file:
```yaml
channel_alias: https://forgejo.example.com/api/packages/{owner}/conda
channels:
- https://forgejo.example.com/api/packages/{owner}/conda
default_channels:
- https://forgejo.example.com/api/packages/{owner}/conda
```
2023-03-03 01:44:11 -05:00
| Placeholder | Description |
| ----------- | ------------------------- |
| `owner` | The owner of the package. |
2023-02-26 18:08:07 -05:00
See the [official documentation](https://conda.io/projects/conda/en/latest/user-guide/configuration/use-condarc.html) for explanations of the individual settings.
If you need to provide credentials, you may embed them as part of the channel url (`https://user:password@forgejo.example.com/...`).
## Publish a package
To publish a package, perform a HTTP PUT operation with the package content in the request body.
```
PUT https://forgejo.example.com/api/packages/{owner}/conda/{channel}/{filename}
```
2023-03-03 01:44:11 -05:00
| Placeholder | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------- |
| `owner` | The owner of the package. |
| `channel` | The [channel](https://conda.io/projects/conda/en/latest/user-guide/concepts/channels.html) of the package. (optional) |
| `filename` | The name of the file. |
2023-02-26 18:08:07 -05:00
Example request using HTTP Basic authentication:
```shell
curl --user your_username:your_password_or_token \
--upload-file path/to/package-1.0.conda \
https://forgejo.example.com/api/packages/testuser/conda/package-1.0.conda
```
If you are using 2FA or OAuth use a personal access token instead of the password.
2023-02-26 18:08:07 -05:00
You cannot publish a package if a package of the same name and version 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. |
2023-02-26 18:08:07 -05:00
## Install a package
To install a package from the package registry, execute one of the following commands:
```shell
conda install {package_name}
conda install {package_name}={package_version}
conda install -c {channel} {package_name}
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| ----------------- | -------------------------------------- |
| `package_name` | The package name. |
| `package_version` | The package version. |
2023-02-26 18:08:07 -05:00
| `channel` | The channel of the package. (optional) |