nuget.config hänvisning

NuGet-beteende styrs av inställningar i olika NuGet.Config filer eller nuget.config enligt beskrivningen i Vanliga NuGet-konfigurationer.

nuget.config är en XML-fil som innehåller en nod på den översta nivån <configuration> , som sedan innehåller avsnittselementen som beskrivs i det här avsnittet. Varje avsnitt innehåller noll eller fler objekt. Se exempelkonfigurationsfilen. Inställningsnamn är skiftlägeskänsliga och värden kan använda miljövariabler.

Konfigurationsavsnitt

Innehåller diverse konfigurationsinställningar som kan ställas in med kommandotnuget config .

dependencyVersion och repositoryPath gäller endast för projekt som använder packages.config. globalPackagesFolder gäller endast för projekt som använder PackageReference-formatet.

Exempel:

<config>
    <add key="dependencyVersion" value="Highest" />
    <add key="globalPackagesFolder" value="c:\packages" />
    <add key="repositoryPath" value="c:\installed_packages" />
    <add key="http_proxy" value="http://company-squid:3128@contoso.com" />
    <add key="signatureValidationMode" value="require" />
    <add key="maxHttpRequestsPerSource" value="16" />
    <add key="updatePackageLastAccessTime" value="false" />
</config>

bindingRedirects-avsnitt

Konfigurerar om NuGet gör automatiska bindningsomdirigeringar när ett paket installeras.

Exempel:

<bindingRedirects>
    <add key="skip" value="True" />
</bindingRedirects>

packageRestore-avsnittet

Styr paketåterställningen under byggen.

Exempel:

<packageRestore>
    <add key="enabled" value="true" />
    <add key="automatic" value="true" />
</packageRestore>

lösningsavsnitt

Styr om mappen för packages en lösning ingår i källkontrollen. Det här avsnittet fungerar endast i nuget.config filer i en lösningsmapp.

Exempel:

<solution>
    <add key="disableSourceControlIntegration" value="true" />
</solution>

Paketkällans avsnitt

Alla packageSourcesdisabledPackageSourcespackageSourceMappingpackageSourceCredentialsapikeysactivePackageSourcetrustedSigners arbetar tillsammans för att konfigurera hur NuGet fungerar med paketlagringsplatser under installation, återställning och uppdatering.

Kommandotnuget sources används vanligtvis för att hantera de här inställningarna, förutom apikeys som hanteras med kommandotnuget setapikey och trustedSigners som hanteras med kommandotnuget trusted-signers .

Observera att käll-URL:en för nuget.org är https://api.nuget.org/v3/index.json.

packageSources

Visar en lista över alla kända paketkällor. Ordningen ignoreras under återställningsåtgärder och med alla projekt som använder PackageReference-formatet. NuGet respekterar ordningen på källor för installations- och uppdateringsåtgärder med projekt som använder packages.config.

Exempel:

<packageSources>
    <clear />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
    <add key="Contoso" value="https://contoso.com/packages/" />
    <add key="http-source" value="http://httpsourcetrusted/" allowInsecureConnections="true" />
    <add key="Invalid-certificate-https-source" value="https://httpsSourceTrusted/" disableTLSCertificateValidation="true" />
    <add key="Test Source" value="c:\packages" />
</packageSources>

auditSources

Visar en lista över alla kända granskningskällor som NuGet-granskning kommer att använda under återställningen. Om inga granskningskällor tillhandahålls använder återställningen paketkällor och undertrycker NU1905. auditSources lades till i NuGet 6.12.

Granskningskällor stöder samma attribut som (, ) och källor som kräver autentisering konfigureras med packageSourceCredentials, på samma sätt som packageSources. allowInsecureConnectionsprotocolVersionpackageSources

Exempel:

<auditSources>
    <clear />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</auditSources>

packageSourceCredentials

Lagrar användarnamn och lösenord för källor, som vanligtvis anges med -username och -password växlar med nuget sources. Lösenord krypteras som standard om inte alternativet -storepasswordincleartext också används. Du kan också ange giltiga autentiseringstyper med växeln -validauthenticationtypes .

Example:

I konfigurationsfilen innehåller elementet <packageSourceCredentials> underordnade noder för varje tillämpligt källnamn (blanksteg i namnet ersätts med _x0020_). För källor med namnet "Contoso" och "Test Source" innehåller konfigurationsfilen följande när krypterade lösenord används:

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="Password" value="..." />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="Password" value="..." />
    </Test_x0020_Source>
</packageSourceCredentials>

Dessutom kan giltiga autentiseringsmetoder anges.

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="Password" value="..." />
        <add key="ValidAuthenticationTypes" value="basic" />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="Password" value="..." />
        <add key="ValidAuthenticationTypes" value="basic, negotiate" />
    </Test_x0020_Source>
</packageSourceCredentials>

När du använder okrypterade lösenord som lagras i en miljövariabel:

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="ClearTextPassword" value="%ContosoPassword%" />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="ClearTextPassword" value="%TestSourcePassword%" />
    </Test_x0020_Source>
</packageSourceCredentials>

När du använder okrypterade lösenord:

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="ClearTextPassword" value="33f!!lloppa" />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="ClearTextPassword" value="hal+9ooo_da!sY" />
    </Test_x0020_Source>
</packageSourceCredentials>

apikeys

Lagrar nycklar för källor som använder API-nyckelautentisering enligt nuget setapikey kommandot .

Exempel:

<apikeys>
    <add key="https://MyRepo/ES/api/v2/package" value="encrypted_api_key" />
</apikeys>

disabledPackageSources

Identifierade för närvarande inaktiverade källor. Kan vara tomt. Om inte specifika källor är inaktiverade i det här avsnittet är de aktiverade.

Example:

<disabledPackageSources>
    <add key="Contoso" value="true" />
</disabledPackageSources>

<!-- Empty list -->
<disabledPackageSources />

I exemplet ovan är paketkällan Contoso inaktiverad och används inte för att ladda ned eller installera paket.

activePackageSource

(endast 2.x; inaktuell i 3.x+)

Identifierar den aktuella aktiva källan eller anger summan av alla källor.

Exempel:

<activePackageSource>
    <!-- Only one active source-->
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />

    <!-- All non-disabled sources are active -->
    <add key="All" value="(Aggregate source)" />
</activePackageSource>

avsnittet trustedSigners

Lagrar betrodda undertecknare som används för att tillåta paket vid installation eller återställning. Den här listan får inte vara tom när användaren anger signatureValidationMode till require.

Det här avsnittet kan uppdateras med nuget trusted-signers kommandot .

Schema:

En betrodd undertecknare har en samling certificate objekt som registrerar alla certifikat som identifierar en viss undertecknare. En betrodd undertecknare kan vara antingen en Author eller en Repository.

En betrodd lagringsplats anger serviceIndex också för lagringsplatsen (som måste vara en giltig https URI) och kan också ange en semikolonavgränsad lista över owners för att begränsa ännu fler som är betrodda från den specifika lagringsplatsen.

De hash-algoritmer som stöds som används för ett certifikats fingeravtryck är SHA256, SHA384 och SHA512.

Om en certificate anger som true det angivna certifikatet tillåts allowUntrustedRoot att länka till en obetrodd rot när certifikatkedjan skapas som en del av signaturverifieringen.

Exempel:

<trustedSigners>
    <author name="microsoft">
        <certificate fingerprint="3F9001EA83C560D712C24CF213C3D312CB3BFF51EE89435D3430BD06B5D0EECE" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="AA12DA22A49BCE7D5C1AE64CC1F3D892F150DA76140F210ABD2CBFFCA2C18A27" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="566A31882BE208BE4422F7CFD66ED09F5D4524A5994F50CCC8B05EC0528C1353" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
    </author>
    <repository name="nuget.org" serviceIndex="https://api.nuget.org/v3/index.json">
        <certificate fingerprint="0E5F38F57DC1BCC806D8494F4F90FBCEDD988B46760709CBEEC6F4219AA6157D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="5A2901D6ADA3D18260B9C6DFE2133C95D74B9EEF6AE0E5DC334C8454D1477DF4" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="1F4B311D9ACC115C8DC8018B5A49E00FCE6DA8E2855F9F014CA6F34570BC482D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />        
        <owners>microsoft;aspnet;nuget</owners>
    </repository>
</trustedSigners>

avsnittet fallbackPackageFolders

(3.5+) Ger ett sätt att förinstallera paket så att inget arbete behöver utföras om paketet hittas i reservmapparna. Reservpaketmappar har exakt samma mapp och filstruktur som den globala paketmappen: .nupkg finns och alla filer extraheras.

Uppslagslogik för den här konfigurationen är:

• Titta i den globala paketmappen för att se om paketet/versionen redan har laddats ned.

• Leta efter ett paket/en versionsmatchning i reservmapparna.

Om någon av sökningarna lyckas krävs ingen nedladdning.

Om en matchning inte hittas kontrollerar NuGet filkällor och sedan http-källor och laddar sedan ned paketen.

Exempel:

<fallbackPackageFolders>
   <add key="XYZ Offline Packages" value="C:\somePath\someFolder\"/>
</fallbackPackageFolders>

Avsnittet paketkällamappning

Avsnittet packageSourceMapping innehåller information som hjälper NuGet-paketåtgärderna att avgöra var ett paket-ID ska laddas ned från.

Det här avsnittet kan bara hanteras manuellt just nu.

Ett packageSourceMapping avsnitt kan bara innehålla packageSource avsnitt.

packageSource

Ett underavsnitt i avsnittet packageSourceMapping . Innehåller en mappning som hjälper NuGet att avgöra om källan ska övervägas för att ladda ned paketet av intresse.

Avsnitten packageSource under packageSourceMapping identifieras unikt av key.

paket

package Är en del av avsnittetpackageSource.

Exempel:

<packageSourceMapping>
  <packageSource key="contoso.com">
    <package pattern="Contoso.*" />
  </packageSource>
</packageSourceMapping>

packageManagement-avsnittet

Anger standardformatet för pakethantering, antingen packages.config eller PackageReference. SDK-projekt använder alltid PackageReference.

Exempel:

<packageManagement>
   <add key="format" value="1" />
   <add key="disabled" value="False" />
</packageManagement>

Använda miljövariabler

Du kan använda miljövariabler i nuget.config värden (NuGet 3.4+) för att tillämpa inställningar vid körning.

Om HOME miljövariabeln i Windows till c:\users\usernameexempel är inställd på , så matchas värdet %HOME%\NuGetRepository för i konfigurationsfilen till c:\users\username\NuGetRepository.

Observera att du måste använda miljövariabler i Windows-stil (startar och slutar med %) även i Mac/Linux. Det går inte att lösa att ha $HOME/NuGetRepository i en konfigurationsfil. På Mac/Linux matchas %HOME%/NuGetRepository värdet för till /home/myStuff/NuGetRepository.

Om en miljövariabel inte hittas använder NuGet literalvärdet från konfigurationsfilen. Till exempel %MY_UNDEFINED_VAR%/NuGetRepository kommer att lösas som path/to/current_working_dir/$MY_UNDEFINED_VAR/NuGetRepository

Tabellen nedan visar stöd för miljövariabelsyntax och sökvägsavgränsare för NuGet.Config-filer.

NuGet.Config stöd för miljövariabler

Exempel på konfigurationsfil

Nedan visas en exempelfil nuget.config som illustrerar ett antal inställningar, inklusive valfria:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <config>
        <!--
            Used to specify the default location to expand packages.
            See: nuget.exe help install
            See: nuget.exe help update

            In this example, %PACKAGEHOME% is an environment variable.
            This syntax works on Windows/Mac/Linux
        -->
        <add key="repositoryPath" value="%PACKAGEHOME%/External" />

        <!--
            Used to specify default source for the push command.
            See: nuget.exe help push
        -->

        <add key="defaultPushSource" value="https://MyRepo/ES/api/v2/package" />

        <!-- Proxy settings -->
        <add key="http_proxy" value="host" />
        <add key="http_proxy.user" value="username" />
        <add key="http_proxy.password" value="encrypted_password" />
    </config>

    <packageRestore>
        <!-- Allow NuGet to download missing packages -->
        <add key="enabled" value="True" />

        <!-- Automatically check for missing packages during build in Visual Studio -->
        <add key="automatic" value="True" />
    </packageRestore>

    <!--
        Used to specify the default Sources for list, install and update.
        See: nuget.exe help list
        See: nuget.exe help install
        See: nuget.exe help update
    -->
    <packageSources>
        <clear />
        <add key="NuGet official package source" value="https://api.nuget.org/v3/index.json" />
        <add key="MyRepo - ES" value="https://MyRepo/ES/nuget" />
    </packageSources>

    <!-- Used to store credentials -->
    <packageSourceCredentials />

    <!-- Used to disable package sources  -->
    <disabledPackageSources />

    <!--
        Used to specify default API key associated with sources.
        See: nuget.exe help setApiKey
        See: nuget.exe help push
        See: nuget.exe help mirror
    -->
    <apikeys>
        <add key="https://MyRepo/ES/api/v2/package" value="encrypted_api_key" />
    </apikeys>

    <!--
        Used to specify trusted signers to allow during signature verification.
        See: nuget.exe help trusted-signers
    -->
    <trustedSigners>
        <author name="microsoft">
            <certificate fingerprint="3F9001EA83C560D712C24CF213C3D312CB3BFF51EE89435D3430BD06B5D0EECE" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="AA12DA22A49BCE7D5C1AE64CC1F3D892F150DA76140F210ABD2CBFFCA2C18A27" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="566A31882BE208BE4422F7CFD66ED09F5D4524A5994F50CCC8B05EC0528C1353" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        </author>
        <repository name="nuget.org" serviceIndex="https://api.nuget.org/v3/index.json">
            <certificate fingerprint="0E5F38F57DC1BCC806D8494F4F90FBCEDD988B46760709CBEEC6F4219AA6157D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="5A2901D6ADA3D18260B9C6DFE2133C95D74B9EEF6AE0E5DC334C8454D1477DF4" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="1F4B311D9ACC115C8DC8018B5A49E00FCE6DA8E2855F9F014CA6F34570BC482D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <owners>microsoft;aspnet;nuget</owners>
        </repository>
    </trustedSigners>
</configuration>