NuGet Repositories

To create a local repository for which Artifactory will calculate NuGet package metadata, in the Administration module, go to Repositories| Repositories | Local and select NuGet to be the Package Type.

Local Repository Layout

To support a more manageable repository layout, you may store NuGet packages inside folders that correspond to the package structure.

Artifactory will find your packages by performing a property search so the folder hierarchy does not impact performance.

To use a hierarchical layout for your repository you should define a Custom Layout. This way, different maintenance features like version cleanup will work correctly with NuGet packages.

Read More: JFrog Artifactory and NuGet Repositories

Placing packages to match your repository layout

Defining a Custom Layout for your repository does not force you to place your packages in the corresponding structure, however it is recommended to do so since it allows Artifactory to perform different maintenance tasks, such as version cleanup, automatically.

It is up to the developer to correctly deploy packages into the corresponding folder. From NuGet 2.5 you can push packages into a folder source as follows:

nuget push mypackage.1.0.0.nupkg -Source http://10.0.0.14:8081/artifactory/api/nuget/nuget-local/path/to/folder

Below is an example of a Custom Layout named nuget-default.

In this example, the three fields that are mandatory for module identification are:

• Organization = orgPath

• Module = module

• Base Revision (baseRev) is not a part of the layout hierarchy in this example, but it is included here as one of the required fields.

You can configure this Custom Layout as displayed in the image above, or simply copy the below code snippet into the relevant section in your Global Configuration Descriptor:Artifactory Configuration Files

<repoLayout>
        <name>nuget-default</name>
    <artifactPathPattern>[orgPath]/[module]/[module].[baseRev](-[fileItegRev]).[ext]</artifactPathPattern>
    <distinctiveDescriptorPathPattern>false</distinctiveDescriptorPathPattern>
    <folderIntegrationRevisionRegExp>.*</folderIntegrationRevisionRegExp>
    <fileIntegrationRevisionRegExp>.*</fileIntegrationRevisionRegExp>
</repoLayout>

Since the package layout is in a corresponding folder hierarchy, the Artifactory Version Cleanup tool correctly detects previously installed versions.

When working with remote NuGet repositories, your Artifactory configuration depends on how the remote repositories are set up.

Different NuGet server implementations may provide package resources on different paths, therefore the feed and download resource locations in Artifactory are customizable when proxying a remote NuGet repository.

To create a Remote Repository, in the Administration module, go to Repositories | Repositories | Remote, and click New Remote Repository.

Here are some examples:

A Virtual Repository defined in Artifactory aggregates packages from both local and remote repositories.

This allows you to access both locally hosted NuGet packages and remote proxied NuGet libraries from a single URL defined for the virtual repository.

To create a virtual NuGet repository, in the Administration module, under Repositories | Repositories | Virtual, click New Virtual Repository and set NuGet to be its Package Type. Select the underlying local and remote NuGet repositories to include under the Repositories section.

NuGet tools require that sensitive operations such as push and delete are authenticated with the server using an apikey. The API key you should use is in the form of username:password, where the password can be either clear-text or encrypted.Centrally Secure Passwords

Set your API key using the NuGet Command Line Interface:

nuget setapikey admin:password -Source Artifactory

Now you can perform operations against the newly added server. For example:

nuget list -Source Artifactory
 
nuget install log4net -Source Artifactory

You can also authenticate with the server using an Access Token.

Note that the following also use Access Tokens:

nuget sources Add -Name <SourceName> -Source <ArtifactoryURL/artifactory/api/nuget/ctie-mobile-snapshots>

nuget setapikey <ACCESSTOKEN> -Source <SourceName>

In order to be able to trace how users interact with your repositories we recommend that you uncheck the Allow Anonymous Access setting described above. This means that users will be required to enter their user name and password when using their NuGet clients.

You can configure your NuGet client to require a username and password using the following command:

nuget sources update -Name Artifactory -UserName admin -Password password

You can verify that your setting has taken effect by checking that the following segment appears in your%APPDATA%\NuGet\NuGet.Config file:

<packageSourceCredentials>
    <Artifactory>
        <add key="Username" value="admin" />
        <add key="Password" value="...encrypted password..." />
    </Artifactory>
</packageSourceCredentials>

Artifactory supports NuGet repositories with Allow Anonymous Access enabled.

When Allow Anonymous Access is enabled, Artifactory will not query the NuGet client for authentication parameters by default, so you need to indicate to Artifactory to request authentication parameters in a different way.

You can override the default behavior by setting the Force Authentication checkbox in the New or Edit Repository dialog.

When set, Artifactory will first request authentication parameters from the NuGet client before trying to access this repository.

Manually add the protocolVersion=3 attribute to the NuGet.Config file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
    <add key="ArtifactoryV3Remote" value="http://artifactory:8081/artifactory/api/nuget/v3/nuget-remote" protocolVersion="3" />
</packageSources>
...
...
</packageSourceCredentials>
</configuration>