Setting Up a Private NuGet Feed for Azure
|Product||Progress® Telerik® UI for ASP.NET Core|
How can I set up the private NuGet feed in Azure to publish an ASP.NET Core application that references the Telerik UI for ASP.NET Core package?
Two options are available when restoring Telerik NuGet packages in your build definitions.
- A Service Connection
- Azure Artifacts
Both require that a private NuGet feed is set up along with a nuget.config file.
In Visual Studio add a private NuGet feed by going into the Tools > Options > NuGet > Package Sources and add a Package Source.
Visual Studio will prompt you for your Telerik credentials the first time the feed is accessed. These credentials can be later accessed via the Windows Credentials tab in the Credential Manager app (e.g. to update password).
Setting up the nuget.config file
The NuGet config file allows you to set package sources as well as where to get the credentials.
NuGet.configto the WebApp project in Visual Studio.
- Add a new
NuGet.configitem to the same directory as the
project.jsonfile is located.
Set your own username and password (in clear text) that are needed to log in to the Telerik site. The following example demonstrates how to do this.
<?xml version="1.0" encoding="utf-8"?> <configuration> <packageSources> <add key="Telerik" value="https://nuget.telerik.com/v3/index.json" /> <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" /> </packageSources> <packageSourceCredentials> <Telerik> <add key="Username" value="firstname.lastname@example.org" /> <add key="ClearTextPassword" value="********" /> </Telerik> </packageSourceCredentials> </configuration>
However, this could be a security issue in a CI/CD environment where another user might be able to read the values of environment variables. The Azure DevOps Service Connection resolves this as it lets you enter credentials in a secure manner without unnecessarily exposing account details. That Service Connection can now be used by multiple pipelines to authenticate private NuGet feeds (and other services that need authentication).
You cannot use
ClearTextPassword. This is because Password is an encrypted value, set on a specific Windows machine, and is only supported on Windows. See the NuGet packageSourceCredentials documentation for more information.
Go to the Project Settings in your DevOps project portal.
On the Project Settings page, select the Service Connections menu item under Pipelines and then open the New Service Connection drop down.
Select NuGet from the drop-down list.
Enter the URL and authentication credentials in the dialog window. For the Telerik NuGet server select Basic Authentication. Once that selection is made, you can enter the Telerik server URL and use your Telerik account credentials.
Once the setup is completed your build pipelines can now fetch packages from the Telerik NuGet feed.
In your build pipeline, there's a NuGet Restore step. Select that step and look to the properties panel. Change the Feeds to Use selection to Feeds in my NuGet.config. A new drop-down will appear titled "Credentials for feeds outside this organization/collection." Open it and select the newly available Telerik NuGet Service Connection.
When you queue and run the pipeline, the Telerik NuGet packages will be restored.
If you do not want pipelines to have unfettered access to the Telerik account holder's downloads, you can host the NuGet package your on your own feed right in the DevOps project with the Azure Artifacts feature. To set up the Azure Artifacts:
Go to the project's main menu, select Artifacts and then click the New Feed button at the top.
Give the feed a name (e.g. TelerikPackages), select the "Only use packages published to this feed" option, then click the Create button. You will now have your own feed that you can push nupkg files to. To see how to push packages to this feed, click the "Connect to feed" option at the top. A dialog will appear with helpful information on how you can push packages to that specific feed.
You can get the NuGet package file (nupkg) for any Telerik product you're using by going to the downloads page for that product. You can start at the My Account - Downloads page.
Underneath the installer for the product, you will find the Other Setup Files section where the nupkg files will be. For example, here's what it looks like for the Telerik UI for ASP.NET Core packages.
Go to the build pipeline and select that feed for a NuGet Restore step.
Just like when using a Service Connection, go to the build pipeline and select the NuGet Restore step. Except this time for the Feeds to Use option choose Feed(s) I select here and choose the TelerikPackages feed in the Use packages from this Azure Artifacts/TFS feed drop-down list.
Important: If you have nuget.org packages to restore in addition to the Telerik packages, leave the "Use packages from NuGet.org" option selected.