nuget.config 參考

NuGet 行為是由不同NuGet.Config或nuget.config檔案中的設定所控制，如一般 NuGet 組態中所述。

nuget.config 是包含最上層 <configuration> 節點的 XML 檔案，該節點則包含本主題中所述的區段項目。 每個區段都包含零個或多個專案。 請參閱設定檔範例。 設定名稱會區分大小寫，而且值可以使用環境變數。

config 區段

包含其他組態設定，可以使用 nuget config 命令設定。

dependencyVersion 和 repositoryPath 僅適用於使用 packages.config的專案。 globalPackagesFolder 僅適用於使用 PackageReference 格式的專案。

範例：

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

設定 NuGet 在安裝套件時，是否自動繫結重新導向。

範例：

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

packageRestore 區段

控制建置期間的套件還原。

範例：

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

solution 區段

控制解決方案的 packages 資料夾是否會包含在原始檔控制。 本區段只適用於解決方案資料夾中的 nuget.config 檔。

範例：

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

套件來源區段

packageSources、packageSourceCredentials、apikeys、activePackageSource、 disabledPackageSourcestrustedSigners 和 packageSourceMapping 全都會一起運作，以設定 NuGet 在安裝、還原和更新作業期間，如何與套件存放庫搭配運作。

命令nuget sources通常用來管理這些設定，但除了apikeys使用 命令進行管理nuget setapikey，以及trustedSigners使用 nuget trusted-signers 命令管理的設定。

請注意，nuget.org 的來源 URL 是 https://api.nuget.org/v3/index.json。

packageSources

列出所有已知的套件來源。 還原作業期間以及使用 PackageReference 格式的任何專案會忽略順序。 NuGet 會遵循使用 來安裝及更新專案 packages.config之來源的順序。

範例：

<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

列出所有已知的稽核來源， NuGet 稽 核將在還原期間使用。 如果未提供稽核來源，還原將會使用套件來源並隱藏 NU1905。 auditSources 已新增至 NuGet 6.12。

稽核來源支援與 #protocolVersion、 和需要驗證packageSourceCredentials的來源相同的屬性packageSources，其設定方式與 packageSourcesallowInsecureConnections相同。

範例：

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

packageSourceCredentials

儲存來源的使用者名稱和密碼，通常使用 nuget sources 的 -username 和 -password 參數來指定。 依預設會加密密碼，除非同時使用了 -storepasswordincleartext 選項。 您可以選擇性地使用 -validauthenticationtypes 參數來指定有效的驗證類型。

範例：

設定檔中，<packageSourceCredentials> 項目包含每個適用來源名稱的子節點 (名稱中的空格會取代為 _x0020_)。 也就是說，對於名為 "Contoso" 和 "Test Source" 的來源，在使用加密的密碼時設定檔時包含下列內容：

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

此外，也可以提供有效的驗證方法。

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

使用儲存在環境變數中的未加密密碼時：

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

使用未加密的密碼時：

<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

為使用 API 金鑰驗證的來源儲存金鑰，如同以 nuget setapikey 命令所設。

範例：

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

disabledPackageSources

識別目前已停用的來源。 可以是空的。 除非本節中停用特定來源，否則會啟用它們。

範例：

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

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

在上述範例中，套件來源 Contoso 已停用，且不會用來下載或安裝套件。

activePackageSource

(僅 2.x，在 3.x+ 中已被取代)

識別目前作用中的來源，或表示所有來源的彙總。

範例：

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

trustedSigners 區段

儲存用來在安裝或還原時允許封裝的信任簽署者。 當使用者將 設定 signatureValidationMode 為 require時，此清單不可以是空的。

您可以使用 命令來更新nuget trusted-signers本節。

結構描述：

信任的簽署者具有專案集合 certificate ，可登記識別指定簽署者的所有憑證。 信任的簽署者可以是 Author 或 Repository。

受信任的存放庫也會指定serviceIndex存放庫的 （這必須是有效的 https URI），而且可以選擇性地指定 分號分隔清單owners，以限制更多從該特定存放庫信任的人員。

用於憑證指紋的支援哈希演算法為 SHA256、 SHA384 和 SHA512。

certificate如果 指定allowUntrustedRoot為true指定的憑證，則在建置憑證鏈結為簽章驗證的一部分時，允許鏈結至不受信任的根目錄。

範例：

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

（3.5+） 提供預安裝套件的方式，以便在後援資料夾中找到套件時，不需要執行任何工作。 後援套件資料夾具有與全域套件資料夾完全相同的資料夾和檔案結構： .nupkg 存在，而且會擷取所有檔案。

此組態的查閱邏輯為：

• 查看全域套件資料夾，以查看套件/版本是否已下載。

• 查看套件/版本相符的後援資料夾。

如果任一查閱成功，則不需要下載。

如果找不到相符專案，則 NuGet 會檢查檔案來源，然後檢查 HTTP 來源，然後下載套件。

範例：

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

套件來源對應區段

區 packageSourceMapping 段包含可協助 NuGet 套件作業判斷應該從何處下載套件標識碼的詳細數據。

本節目前只能手動管理。

區 packageSourceMapping 段只能包含 packageSource 區段。

packageSource

區段的 packageSourceMapping 子區段。 包含對應，可協助 NuGet 判斷是否應該考慮來源以下載感興趣的套件。

packageSource底下的packageSourceMapping區段是由 唯一識別。key

套件

package是區段的packageSource一部分。

範例：

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

packageManagement 區段

設定預設套件管理格式，即 packages.config 或 PackageReference。 SDK 樣式專案一律使用 PackageReference。

範例：

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

使用環境變數

您可以在 nuget.config 值中使用環境變數 (NuGet 3.4+)，在執行階段套用設定。

例如，如果 Windows 上的 HOME 環境變數設為 c:\users\username，則設定檔中的 %HOME%\NuGetRepository 值會解析為 c:\users\username\NuGetRepository。

請注意，您必須在 Mac/Linux 上使用 Windows 樣式環境變數 （開頭和結尾為 %） 。 在組態檔中擁有 $HOME/NuGetRepository 將不會解析。 在 Mac/Linux 上，的值 %HOME%/NuGetRepository 會解析為 /home/myStuff/NuGetRepository。

如果找不到環境變數，NuGet 會使用來自設定檔的常值。 例如 %MY_UNDEFINED_VAR%/NuGetRepository ，解析為 path/to/current_working_dir/$MY_UNDEFINED_VAR/NuGetRepository

下表顯示 NuGet.Config 檔案的環境變數語法和路徑分隔符支援。

NuGet.Config 環境變數支援

設定檔範例

以下是說明一些設定的範例 nuget.config 檔案，包括選擇性設定：

<?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 enforce that certain packages only come from specific package sources. -->
    <packageSourceMapping>
      <clear />
      <packageSource key="MyRepo - ES">
        <package pattern="ES.*" />
      </packageSource>
      <packageSource key="NuGet official package source">
        <package pattern="*" />
      </packageSource>
    </packageSourceMapping>

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