0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-12 20:53:30 -05:00
forgejo-docs/v1.19/admin/packages/conan.md

89 lines
3 KiB
Markdown
Raw Normal View History

2023-02-26 18:08:07 -05:00
---
layout: '~/layouts/Markdown.astro'
title: 'Conan Packages Repository'
2023-03-03 01:44:11 -05:00
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/packages/conan.en-us.md'
2023-02-26 18:08:07 -05:00
---
Publish [Conan](https://conan.io/) packages for your user or organization.
## Requirements
To work with the Conan package registry, you need to use the [conan](https://conan.io/downloads.html) command line tool to consume and publish packages.
## Configuring the package registry
To register the package registry you need to configure a new Conan remote:
```shell
conan remote add {remote} https://forgejo.example.com/api/packages/{owner}/conan
conan user --remote {remote} --password {password} {username}
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `remote` | The remote name. |
| `username` | Your Forgejo username. |
2023-02-26 18:08:07 -05:00
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. |
2023-03-03 01:44:11 -05:00
| `owner` | The owner of the package. |
2023-02-26 18:08:07 -05:00
For example:
```shell
conan remote add forgejo https://forgejo.example.com/api/packages/testuser/conan
conan user --remote forgejo --password password123 testuser
```
## Publish a package
Publish a Conan package by running the following command:
```shell
conan upload --remote={remote} {recipe}
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| --------- | --------------------- |
| `remote` | The remote name. |
2023-02-26 18:08:07 -05:00
| `recipe` | The recipe to upload. |
For example:
```shell
conan upload --remote=forgejo ConanPackage/1.2@forgejo/final
```
The Forgejo Conan package registry has full [revision](https://docs.conan.io/en/latest/versioning/revisions.html) support.
## Install a package
To install a Conan package from the package registry, execute the following command:
```shell
conan install --remote={remote} {recipe}
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| --------- | ----------------------- |
| `remote` | The remote name. |
2023-02-26 18:08:07 -05:00
| `recipe` | The recipe to download. |
For example:
```shell
conan install --remote=forgejo ConanPackage/1.2@forgejo/final
```
## Supported commands
```
conan install
conan get
conan info
conan search
conan upload
conan user
conan download
conan remove
```