nuget.config referência

O comportamento do NuGet é controlado por configurações em arquivos diferentes NuGet.Config ou nuget.config conforme descrito em Configurações comuns do NuGet.

nuget.config é um arquivo XML que contém um nó de nível <configuration> superior, que contém os elementos de seção descritos neste tópico. Cada seção contém zero ou mais itens. Veja os exemplos de arquivo de configuração. Os nomes de configuração não diferenciam maiúsculas de minúsculas e os valores podem usar variáveis de ambiente.

seção de configuração

Contém definições de configuração diversas, que podem ser definidas usando o nuget config comando.

dependencyVersion e repositoryPath aplicam-se apenas a projetos que utilizem packages.configo . globalPackagesFolder aplica-se apenas a projetos que usam o formato PackageReference.

Exemplo:

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

seção bindingRedirects

Configura se o NuGet faz redirecionamentos de vinculação automática quando um pacote é instalado.

Exemplo:

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

seção packageRestore

Controla a restauração do pacote durante as compilações.

Exemplo:

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

Secção Solução

Controla se a packages pasta de uma solução está incluída no controle do código-fonte. Esta seção funciona somente em nuget.config arquivos em uma pasta de solução.

Exemplo:

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

Seções de origem do pacote

O packageSources, packageSourceCredentials, apikeys, activePackageSource, disabledPackageSourcestrustedSigners e packageSourceMapping todos trabalham juntos para configurar como o NuGet funciona com repositórios de pacotes durante as operações de instalação, restauração e atualização.

O nuget sources comando é geralmente usado para gerenciar essas configurações, exceto apikeys para o que é gerenciado usando o nuget setapikey comando e trustedSigners que é gerenciado usando o nuget trusted-signers comando.

Observe que o URL de origem para nuget.org é https://api.nuget.org/v3/index.json.

packageSources

Lista todas as fontes de pacotes conhecidas. A ordem é ignorada durante as operações de restauração e com qualquer projeto usando o formato PackageReference. O NuGet respeita a ordem das fontes para operações de instalação e atualização com projetos que usam packages.configo .

Exemplo:

<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

Lista todas as fontes de auditoria conhecidas, que o NuGet Audit usará durante a restauração. Se nenhuma fonte de auditoria for fornecida, a restauração usará fontes de pacote e suprimirá o NU1905. auditSources foi adicionado ao NuGet 6.12.

As fontes de auditoria oferecem suporte aos mesmos atributos packageSources que (protocolVersion, allowInsecureConnections), e as fontes que exigem autenticação são configuradas com packageSourceCredentials, da mesma forma packageSourcesque .

Exemplo:

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

packageSourceCredentials

Armazena nomes de usuário e senhas para fontes, normalmente especificadas com o e -password alterna -username com nuget sources. As senhas são criptografadas por padrão, a menos que a -storepasswordincleartext opção também seja usada. Opcionalmente, tipos de autenticação válidos podem ser especificados com o -validauthenticationtypes switch.

Example:

No arquivo de configuração, o <packageSourceCredentials> elemento contém nós filho para cada nome de origem aplicável (espaços no nome são substituídos por _x0020_). Ou seja, para fontes chamadas "Contoso" e "Test Source", o arquivo de configuração contém o seguinte ao usar senhas criptografadas:

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

Além disso, métodos de autenticação válidos podem ser fornecidos.

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

Ao usar senhas não criptografadas armazenadas em uma variável de ambiente:

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

Ao usar senhas não criptografadas:

<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

Armazena chaves para fontes que usam autenticação de chave de API, conforme definido com o nuget setapikey comando.

Exemplo:

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

disabledPackageSources

Fontes atualmente desativadas identificadas. Pode estar vazio. A menos que fontes específicas estejam desabilitadas nesta seção, elas serão habilitadas.

Example:

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

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

No exemplo acima, a fonte Contoso do pacote está desativada e não será usada para baixar ou instalar pacotes.

activePackageSource

(apenas 2.x; preterido em 3.x+)

Identifica a fonte atualmente ativa ou indica o agregado de todas as fontes.

Exemplo:

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

seção trustedSigners

Armazena signatários confiáveis usados para permitir o pacote durante a instalação ou restauração. Essa lista não pode ficar vazia quando o usuário define signatureValidationMode como require.

Esta seção pode ser atualizada com o nuget trusted-signers comando.

Esquema:

Um signatário confiável tem uma coleção de certificate itens que alistam todos os certificados que identificam um determinado signatário. Um signatário confiável pode ser um Author ou um Repository.

Um repositório confiável também especifica o para o repositório (que deve ser um uri válidohttps) e pode, opcionalmente, especificar uma lista delimitada por ponto-e-vírgula serviceIndex para owners restringir ainda mais quem é confiável a partir desse repositório específico.

Os algoritmos de hash suportados usados para uma impressão digital de certificado são SHA256, SHA384 e SHA512.

Se um certificate especifica allowUntrustedRoot como true o certificado dado tem permissão para encadear para uma raiz não confiável durante a criação da cadeia de certificados como parte da verificação de assinatura.

Exemplo:

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

seção fallbackPackageFolders

(3,5+) Fornece uma maneira de pré-instalar pacotes para que nenhum trabalho precise ser feito se o pacote for encontrado nas pastas de fallback. As pastas do pacote de fallback têm exatamente a mesma estrutura de pastas e arquivos que a pasta do pacote global: .nupkg está presente e todos os arquivos são extraídos.

A lógica de pesquisa para esta configuração é:

• Procure na pasta global do pacote para ver se o pacote/versão já foi baixado.

• Procure nas pastas de fallback uma correspondência de pacote/versão.

Se qualquer pesquisa for bem-sucedida, nenhum download será necessário.

Se uma correspondência não for encontrada, o NuGet verificará as fontes de arquivo e, em seguida, as fontes http e, em seguida, baixará os pacotes.

Exemplo:

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

Seção de mapeamento de origem do pacote

A packageSourceMapping seção contém os detalhes que ajudam as operações do pacote NuGet a determinar de onde uma ID de pacote deve ser baixada.

Esta seção só pode ser gerenciada manualmente no momento.

Uma packageSourceMapping secção só pode conter packageSource secções.

packageSource

Uma subsecção da packageSourceMapping secção. Contém um mapeamento para ajudar o NuGet a determinar se a fonte deve ser considerada para baixar o pacote de interesse.

As packageSource seções abaixo packageSourceMapping são identificadas exclusivamente pelo key.

pacote

O package faz parte da packageSource secção.

Exemplo:

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

Seção packageManagement

Define o formato de gerenciamento de pacotes padrão, packages.config ou PackageReference. Projetos no estilo SDK sempre usam PackageReference.

Exemplo:

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

Usando variáveis de ambiente

Você pode usar variáveis de ambiente em nuget.config valores (NuGet 3.4+) para aplicar configurações em tempo de execução.

Por exemplo, se a HOME variável de ambiente no Windows estiver definida como c:\users\username, o valor de no arquivo de %HOME%\NuGetRepository configuração será resolvido como c:\users\username\NuGetRepository.

Observe que você tem que usar variáveis de ambiente no estilo do Windows (começa e termina com %) mesmo no Mac / Linux. Ter $HOME/NuGetRepository em um arquivo de configuração não será resolvido. No Mac/Linux o valor de %HOME%/NuGetRepository será resolvido para /home/myStuff/NuGetRepository.

Se uma variável de ambiente não for encontrada, o NuGet usará o valor literal do arquivo de configuração. Por exemplo %MY_UNDEFINED_VAR%/NuGetRepository , será resolvido como path/to/current_working_dir/$MY_UNDEFINED_VAR/NuGetRepository

A tabela abaixo mostra a sintaxe da variável de ambiente e o suporte ao separador de caminho para arquivos NuGet.Config.

NuGet.Config Suporte a variáveis de ambiente

Exemplo de arquivo de configuração

Abaixo está um arquivo de exemplo nuget.config que ilustra uma série de configurações, incluindo opcionais:

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