mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-11-28 18:42:51 -05:00
9af05bfb01
Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md
87 lines
3 KiB
Markdown
87 lines
3 KiB
Markdown
---
|
|
title: 'Conan Package Registry'
|
|
license: 'Apache-2.0'
|
|
origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396bae9e6fe061c/docs/content/doc/usage/packages/conan.en-us.md'
|
|
---
|
|
|
|
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}
|
|
```
|
|
|
|
| Parameter | Description |
|
|
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `remote` | The remote name. |
|
|
| `username` | Your Forgejo username. |
|
|
| `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. |
|
|
| `owner` | The owner of the package. |
|
|
|
|
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}
|
|
```
|
|
|
|
| Parameter | Description |
|
|
| --------- | --------------------- |
|
|
| `remote` | The remote name. |
|
|
| `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}
|
|
```
|
|
|
|
| Parameter | Description |
|
|
| --------- | ----------------------- |
|
|
| `remote` | The remote name. |
|
|
| `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
|
|
```
|