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:
Below is an example of a Custom Layout named
In this example, the three fields that are mandatory for module identification are:
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.
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.
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:
https://www.nuget.org/api/v2/Packagesand its download resource at https://www.nuget.org/api/v2/package
https://www.nuget.org, its Feed Context Path to
api/v2and the Download Context Path to
NuGet.Servermodule exposes its feed resource at
http://host:port/nuget/Packagesand its download resource at
http://host:port, its Feed Context Path to
nugetand its Download Context Path to
http://host:port/api/v3/nuget/repoKeywhile the URL can stay with
http://host:port/artifactory/api/nuget/repoKey/Packagesand its download resource at
http://host:port/artifactory/api/nuget/repoKey, its Feed Context Path should be left empty and its Download Context Path to Download, like this:
If you are accessing NuGet Gallery through a proxy server you need to define the following two URLs in the proxy's allow list:
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.
When configuring Visual Studio to access a NuGet repository through Artfactory, the repository URL must be prefixed with api/nuget in the path.
For example, if you are using Artifactory standalone or as a local service, you would configure Visual Studio using the following URL:
Or, if you are using Artifactory Cloud the URL would be:
Artifactory exposes its NuGet resources via the REST API at the following URL:
This URL handles all NuGet related requests (search, download, upload, delete) and supports both V1 and V2 requests. To use V3 requests, you need to Configure Visual Studio with NuGet v3 API.
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).
When using the NuGet command line to access a repository through Artfactory, the repository URL must be prefixed with
For example, if you are using Artifactory standalone or as a local service, you would access your NuGet repositories using the following URL:
Or, if you are using Artifactory Cloud the URL would be:
To use the Nuget Command Line tool:
NuGet.exeis 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>
To use V3 requests, you need to Configure NuGet CLI with NuGet v3 API.
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
By default, Artifactory allows anonymous access to NuGet repositories. This is defined under Administration | Security | General Configuration. For details please refer to Allow 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>
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.
JFrog has evaluated the implication and can conclude that:
Artifactory now supports NuGet API v3 feeds and allows you to proxy remote NuGet API v3 repositories (e.g. the NuGet gallery) and other remote repositories that are set up with the API v3 feed.
To enable API v3, configure the remote repo v3 feed URL value.
Manually add the
protocolVersion=3 attribute to the NuGet.Config file:
/v3/to the source URL.
<?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>
Artifactory now supports SemVer 2.0 rules for NuGet repositories (for both NuGet API v2 and API v3), which means you can now use pre-release numbers with dot notation or add metadata to the version, for example:
Artifactory serves the requests for downloading packages in SemVer 2.0 rules. For example, if the latest version for a certain package is in SemVer 2.0 convention, Artifactory will return it to the client. NuGet packages with the SemVer 2.0 convention are served from local, remote, and virtual repositories and for both NuGet API v2, and v3 feeds.
NuGet packages with SemVer2 are not available for old NuGet clients (prior to version 4.3.0). This is a breaking change that was made to align with the official global repository behaviour. To retain the old behaviour, use the
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:
You may store exhaustive build information in Artifactory by running your NuGet builds with JFrog CLI.
JFrog CLI collects build-info from your build agents and then publishes it to Artifactory. Once published, the build info can be viewed in the under Builds.
For more details on NuGet build integration using JFrog CLI, please refer to Building NuGet Packages in the JFrog CLI User Guide
<iframe width="560" height="315" src="https://www.youtube.com/embed/IlNWNWu0Q_o" frameborder="0" allowfullscreen></iframe>