Cargo Package Registry

Configuration

Local Repositories

To enable calculation of Cargo metadata, in the Administration module, go to Repositories | Repositories | Local and select Cargo as the Package Type when you create your local repository.

Local Repository Layout

You will need to maintain a specific path structure to manage the Cargo packages that are uploaded to Cargo local repositories. 

Cargo Source packages are automatically uploaded by default to the relative path: crates/{package_name}/{package_name}-{version}.crate.

Yank and Un-yank Crates in Local Repositories

Artifactory supports yanking and un-yanking crates in local repositories.

cargo yank hello_world --vers 0.1.4 --token "Bearer (token)"
cargo yank hello_world --vers 0.1.4 --token "Bearer (token)" --undo

Remote Repositories

You can create remote Cargo repositories to proxy and cache remote repositories or other Artifactory instances.
The Registry URL has been added to Cargo remote repositories, to reflect the index (git) location: 

• For external repositories, the path should be the same as the URL. For example: https://github.com/rust-lang/crates.io-index
• For Smart remote repositories, the path should be http(s)://art_url/artifactory/git/repo_name.git. For example: http://127.0.0.1/artifactory/git/cargo-local.git.

Resolving Cargo Packages

To resolve Cargo packages:

1. In the Application module, navigate to Artifactory | Artifacts. 

2. In the Artifact Tree Browser, select a Cargo repository and click Set Me Up.

   Password Authentication Requirement

   The 'Type Password' box is displayed only if you need to perform re-authentication opposite the JFrog Platform. This option will not be available in the UI for users applying external authentication methods such as SAML or OAuth.

   
   

   To set your credentials for API calls such as publish and yank, add the following section to the credentials file under your Cargo home directory (for example ~/.cargo/credentials):

   [registries.artifactory]
   token = "Bearer <TOKEN>"

3. Copy the Cargo code snippets to publish a Cargo package or to configure your Rust client to resolve the artifacts in the selected repository.

Resolving Cargo Packages Using the Rust Command Line

1. In the Application module, navigate to Artifactory | Artifacts. 

2. In the Artifact Tree Browser, select a Cargo repository and click Set Me Up.

3. Install a package using the Cargo build or install commands.
   

   Cargo install

   cargo install crate

   Resolving Multiple Cargo Registries

   To resolve multiple registries, add this optional flag --registry (registryId).

Deploying Cargo Packages

You can deploy packages to a local Cargo repository using the Cargo Client, using the Deploy feature in the UI, or using a cURL request.

Deploying a Package Using the Cargo Client (Recommended)

To deploy a package, run the following Cargo publish command. 

cargo publish or cargo publish --registry (registry id)

To override the credentials for that repository, run the following command. 

cargo publish --token "Basic (base64 of user:password)"or cargo publish --token "Bearer (access token)"

Deploying a Package Using the UI 

You can either drag and drop, or select a Cargo package to upload in Deploy in the UI. Artifactory will automatically identify if the package is a source or binary package. 

crates/{package_name}/{package_name}-{version}.crate

Deploying a Package Using cURL

To deploy a package using a cURL request.

curl -uadmin:password -XPUT "http://localhost:8082/artifactory/cargo-local/crates/package_1.0.0.crate" -T package_1.0.0.crate

When deploying directly (PUT request to a specific path), make sure the target path is a valid Cargo path.

crates/{package_name}/{package_name}-{version}.crate

Note that deploying a package to a different path will not identify the package as Cargo packages, and will not invoke metadata indexing.

Viewing Individual Cargo Package Information

Artifactory lets you view selected metadata of a Cargo package directly from the UI.

In the Artifact Repository Browser, select your local Cargo repository and scroll down to find and select the package you want to inspect.

The metadata is displayed in the Cargo Info tab, or view in the Packages view.

Re-indexing a Cargo Repository

You can trigger an asynchronous re-indexing of a local Cargo repository either through the UI or using the REST API.

This will also reindex the git index and, as a result, will also index the remote repositories.

In the Artifact Tree Browser, select your Cargo repository, right-click and select Recalculate Index from the list. Requires Admin privileges.

To reindex a Cargo repository through the REST API, refer to Calculate Cargo Repository Metadata.

Setting Up Cargo Indexing Using Sparse Indexing

From Artifactory version 7.46.3, Cargo sparse indexing is supported. Sparse Indexing allows you to control the connections that are entered into the index database. Sparse indexing also allows for:

• Faster build times, since no Git clones/ pulls are involved 
• Using a proxy for Remote Cargo Repositories. 

To enable Cargo sparse indexing: 

• For all Cargo repositories globally, in the Repository Configuration JSON, add the "cargoInternalIndex": true flag.
• For individual Cargo repositories, select the Enable sparse index support checkbox in the General Settings section of the Cargo Repository Basic tab on the JFrog Platform UI.
  • For existing repositories, reindex after applying the flag.
  • For new repositories, no initialization time is required, as no Git clone is created behind the scenes.

Rules and Guidelines

• When configuring as a Smart Remote repository, the URL should be http://domain/artifactory/cargo-local
• While the registry URL should be http://domain/artifactory/api/cargo/cargo-local/index

To use the official Rust Remote Repository URL, create a remote repository with the URL and registry URL https://index.crates.io.

For more information, see the Rust documentation.