nuget.config referentie

NuGet-gedrag wordt bepaald door instellingen in verschillende NuGet.Config of nuget.config bestanden, zoals beschreven in Algemene NuGet-configuraties.

nuget.config is een XML-bestand met een knooppunt op het hoogste niveau <configuration> , dat vervolgens de sectie-elementen bevat die in dit onderwerp worden beschreven. Elke sectie bevat nul of meer items. Zie het configuratiebestand met voorbeelden. Instellingsnamen zijn niet hoofdlettergevoelig en waarden kunnen omgevingsvariabelen gebruiken.

configuratiesectie

Bevat diverse configuratie-instellingen, die kunnen worden ingesteld met behulp van de nuget config opdracht.

dependencyVersion en repositoryPath alleen van toepassing zijn op projecten die gebruikmaken van packages.config. globalPackagesFolder is alleen van toepassing op projecten die gebruikmaken van de PackageReference-indeling.

Voorbeeld:

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

Hiermee configureert u of NuGet automatische bindingsomleidingen doet wanneer een pakket wordt geïnstalleerd.

Voorbeeld:

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

sectie packageRestore

Hiermee bepaalt u het herstellen van pakketten tijdens builds.

Voorbeeld:

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

sectie oplossing

Hiermee bepaalt u of de packages map van een oplossing is opgenomen in broncodebeheer. Deze sectie werkt alleen in nuget.config bestanden in een oplossingsmap.

Voorbeeld:

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

Pakketbronsecties

De packageSources, packageSourceCredentials, apikeys, , activePackageSourceen trustedSignersdisabledPackageSourcespackageSourceMapping alles samenwerken om te configureren hoe NuGet werkt met pakketopslagplaatsen tijdens installatie-, herstel- en updatebewerkingen.

De nuget sources opdracht wordt over het algemeen gebruikt om deze instellingen te beheren, behalve apikeys waarvoor de nuget setapikey opdracht wordt beheerd en trustedSigners die wordt beheerd met behulp van de nuget trusted-signers opdracht.

Houd er rekening mee dat de bron-URL voor nuget.org is https://api.nuget.org/v3/index.json.

packageSources

Een lijst met alle bekende pakketbronnen. De volgorde wordt genegeerd tijdens herstelbewerkingen en met elk project met behulp van de PackageReference-indeling. NuGet respecteert de volgorde van bronnen voor installatie- en updatebewerkingen met projecten die worden gebruikt packages.config.

Voorbeeld:

<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

Geeft een lijst weer van alle bekende controlebronnen, die NuGet Audit tijdens het herstellen zal gebruiken. Als er geen controlebronnen worden opgegeven, gebruikt herstel pakketbronnen en onderdrukt HET NU1905. auditSources is toegevoegd aan NuGet 6.12.

Controlebronnen ondersteunen dezelfde kenmerken als packageSources (protocolVersion, allowInsecureConnections), en bronnen waarvoor verificatie is vereist, worden geconfigureerd op packageSourceCredentialsdezelfde manier als packageSources.

Voorbeeld:

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

packageSourceCredentials

Slaat gebruikersnamen en wachtwoorden op voor bronnen, meestal opgegeven met de -username en -password schakelopties met nuget sources. Wachtwoorden worden standaard versleuteld, tenzij de -storepasswordincleartext optie ook wordt gebruikt. Optioneel kunnen geldige verificatietypen worden opgegeven met de -validauthenticationtypes switch.

Example:

In het configuratiebestand bevat het <packageSourceCredentials> element onderliggende knooppunten voor elke toepasselijke bronnaam (spaties in de naam worden vervangen door _x0020_). Voor bronnen met de naam Contoso en Testbron bevat het configuratiebestand het volgende bij het gebruik van versleutelde wachtwoorden:

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

Daarnaast kunnen geldige verificatiemethoden worden opgegeven.

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

Wanneer u niet-versleutelde wachtwoorden gebruikt die zijn opgeslagen in een omgevingsvariabele:

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

Wanneer u niet-versleutelde wachtwoorden gebruikt:

<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

Slaat sleutels op voor bronnen die gebruikmaken van API-sleutelverificatie, zoals ingesteld met de nuget setapikey opdracht.

Voorbeeld:

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

disabledPackageSources

Momenteel uitgeschakelde bronnen geïdentificeerd. Mag leeg zijn. Tenzij specifieke bronnen zijn uitgeschakeld in deze sectie, zijn ze ingeschakeld.

Example:

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

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

In het bovenstaande voorbeeld is de pakketbron Contoso uitgeschakeld en wordt deze niet gebruikt voor het downloaden of installeren van pakketten.

activePackageSource

(alleen 2.x; afgeschaft in 3.x+)

Identificeert aan de huidige actieve bron of geeft de aggregaties van alle bronnen aan.

Voorbeeld:

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

sectie trustedSigners

Slaat vertrouwde ondertekenaars op die worden gebruikt om het pakket toe te staan tijdens het installeren of herstellen. Deze lijst kan niet leeg zijn wanneer de gebruiker is ingesteld signatureValidationMode op require.

Deze sectie kan worden bijgewerkt met de nuget trusted-signers opdracht.

Schema:

Een vertrouwde ondertekenaar heeft een verzameling certificate items die alle certificaten bevatten die een bepaalde ondertekenaar identificeren. Een vertrouwde ondertekenaar kan een Author of een Repository.

Een vertrouwde opslagplaats geeft ook de serviceIndex voor de opslagplaats (die een geldige https URI moet zijn) op en kan eventueel een door puntkomma's gescheiden lijst opgeven om owners nog meer te beperken wie wordt vertrouwd vanuit die specifieke opslagplaats.

De ondersteunde hash-algoritmen die worden gebruikt voor een certificaatvingerafdruk zijn SHA256, SHA384 en SHA512.

Als een certificate opgegeven als trueallowUntrustedRoot het opgegeven certificaat is toegestaan om te koppelen aan een niet-vertrouwde basis tijdens het bouwen van de certificaatketen als onderdeel van de handtekeningverificatie.

Voorbeeld:

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

fallbackPackageFolders-sectie

(3,5+) Biedt een manier om pakketten vooraf te installeren, zodat er geen werk hoeft te worden uitgevoerd als het pakket wordt gevonden in de terugvalmappen. Terugvalpakketmappen hebben exact dezelfde map- en bestandsstructuur als de globale pakketmap: .nupkg is aanwezig en alle bestanden worden geëxtraheerd.

De opzoeklogica voor deze configuratie is:

• Kijk in de algemene pakketmap om te zien of het pakket/de versie al is gedownload.

• Zoek in de terugvalmappen naar een pakket/versieovereenkomst.

Als een van beide zoekopdrachten is geslaagd, is er geen download nodig.

Als er geen overeenkomst wordt gevonden, controleert NuGet de bestandsbronnen en vervolgens http-bronnen. Vervolgens worden de pakketten gedownload.

Voorbeeld:

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

Sectie Pakketbrontoewijzing

De packageSourceMapping sectie bevat de details waarmee de NuGet-pakketbewerkingen kunnen bepalen waar een pakket-id moet worden gedownload.

Deze sectie kan momenteel alleen handmatig worden beheerd.

Een packageSourceMapping sectie kan alleen secties bevatten packageSource .

pakketbron

Een subsectie van de packageSourceMapping sectie. Bevat een toewijzing om NuGet te helpen bepalen of de bron moet worden overwogen voor het downloaden van het pakket van belang.

De packageSource secties hieronder packageSourceMapping worden uniek geïdentificeerd door de key.

pakket

Het package is onderdeel van de packageSource sectie.

Voorbeeld:

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

packageManagement section

Hiermee stelt u de standaardindeling voor pakketbeheer in, packages.config of PackageReference. Sdk-projecten maken altijd gebruik van PackageReference.

Voorbeeld:

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

Omgevingsvariabelen gebruiken

U kunt omgevingsvariabelen gebruiken in nuget.config waarden (NuGet 3.4+) om instellingen tijdens runtime toe te passen.

Als de HOME omgevingsvariabele in Windows bijvoorbeeld is ingesteld c:\users\usernameop , wordt de waarde van %HOME%\NuGetRepository in het configuratiebestand omgezet in c:\users\username\NuGetRepository.

Houd er rekening mee dat u omgevingsvariabelen in Windows-stijl moet gebruiken (begint en eindigt met %) zelfs op Mac/Linux. Als $HOME/NuGetRepository u een configuratiebestand hebt, wordt dit niet opgelost. Op Mac/Linux wordt de waarde omgezet %HOME%/NuGetRepository in /home/myStuff/NuGetRepository.

Als een omgevingsvariabele niet wordt gevonden, gebruikt NuGet de letterlijke waarde uit het configuratiebestand. Wordt bijvoorbeeld %MY_UNDEFINED_VAR%/NuGetRepository omgezet als path/to/current_working_dir/$MY_UNDEFINED_VAR/NuGetRepository

In de onderstaande tabel ziet u de syntaxis van de omgevingsvariabele en de ondersteuning voor padscheidingstekens voor NuGet.Config-bestanden.

NuGet.Config ondersteuning voor omgevingsvariabelen

Voorbeeldconfiguratiebestand

Hieronder ziet u een voorbeeldbestand nuget.config met een aantal instellingen, waaronder optionele instellingen:

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