NuGet Repositories

Configuration

Local Repositories

To create a local repository for which Artifactory will calculate NuGet package metadata, set 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.

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:

<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.

Publishing to a Local Repository

When a NuGet repository is selected in the Artifacts module Tree Browser, click Set Me Up to display the code snippets you can use to configure Visual Studio or your NuGet client to use the selected repository to publish or resolve artifacts.

Remote Repositories

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.

Here are some examples:

• The NuGet gallery exposes its feed resource at https://www.nuget.org/api/v2/Packages and its download resource at https://www.nuget.org/api/v2/package
  Therefore, to define this as a new repository you should set the repository URL to https://www.nuget.org, its Feed Context Path to api/v2 and the Download Context Path to api/v2/package.
  
  
• The NuGet.Server module exposes its feed resource at http://host:port/nuget/Packages and its download resource at http://host:port/api/v2/package.
  To define this as a new repository you should set the repository URL to http://host:port, its Feed Context Path to nuget and its Download Context Path to api/v2/package.
  
  
• Another Artifactory repository exposes its feed resource at http://host:port/artifactory/api/nuget/repoKey/Packages and its download resource at http://host:port/artifactory/api/nuget/repoKey/Download. 
  To define this as a new repository you should set the repository URL to http://host:port/artifactory/api/nuget/repoKey, its Feed Context Path should be left empty and its Download Context Path to Download, like this:
  

Virtual Repositories

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 Bower repository set NuGet to be its Package Type, and select the underlying local and remote NuGet repositories to include under the Repositories section.

Accessing NuGet Repositories from Visual Studio

Artifactory exposes its NuGet resources via the REST API at the following URL: http://localhost:8081/artifactory/api/nuget/<repository key>.

This URL handles all NuGet related requests (search, download, upload, delete) and supports both V1 and V2 requests.

To configure the NuGet Visual Studio Extension to use Artifactory, check the corresponding repositories in the "Options" window: (You can access Options from the Tools menu).

Using the NuGet Command Line

To use the Nuget Command Line tool:

1. Download NuGet.exe 
2. Place it in a well known location in your file system such as c:\utils
3. Make sure that NuGet.exe is in your path

For complete information on how to use the NuGet Command Line tool please refer to the NuGet Docs Command Line Reference.

First configure a new source URL pointing to Artifactory:

nuget sources Add -Name Artifactory -Source http://localhost:8081/artifactory/api/nuget/<repository key>

NuGet API Key Authentication

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.
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

Anonymous Access to NuGet Repositories

By default, Artifactory allows anonymous access to NuGet repositories. This is defined under Security | General Configuration. For details please refer to Allow Anonymous Access.

Working Without Anonymous Access

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>

Allowing Anonymous Access

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.

Viewing Individual NuGet Package Information

You can view all the metadata annotating a NuGet package by choosing the NuPkg file in Artifactory's tree browser and selecting the NuPkg Info tab:

Watch the Screencast