gitea/docs/content/doc/usage/packages/conan.en-us.md
John Olheiser bb25f85ce8
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00

2.3 KiB

date title slug weight draft toc menu
2021-07-20T00:00:00+00:00 Conan Packages Repository conan 20 false false
sidebar
parent name weight identifier
packages Conan 20 conan

Conan Packages Repository

Publish Conan packages for your user or organization.

Table of Contents

{{< toc >}}

Requirements

To work with the Conan package registry, you need to use the conan 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:

conan remote add {remote} https://gitea.example.com/api/packages/{owner}/conan
conan user --remote {remote} --password {password} {username}
Parameter Description
remote The remote name.
username Your Gitea username.
password Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
owner The owner of the package.

For example:

conan remote add gitea https://gitea.example.com/api/packages/testuser/conan
conan user --remote gitea --password password123 testuser

Publish a package

Publish a Conan package by running the following command:

conan upload --remote={remote} {recipe}
Parameter Description
remote The remote name.
recipe The recipe to upload.

For example:

conan upload --remote=gitea ConanPackage/1.2@gitea/final

The Gitea Conan package registry has full revision support.

Install a package

To install a Conan package from the package registry, execute the following command:

conan install --remote={remote} {recipe}
Parameter Description
remote The remote name.
recipe The recipe to download.

For example:

conan install --remote=gitea ConanPackage/1.2@gitea/final

Supported commands

conan install
conan get
conan info
conan search
conan upload
conan user
conan download
conan remove