Auth & Registry Settings (.npmrc)
The settings on this page must be configured via .npmrc files. pnpm uses the npm CLI under the hood for publishing, so these settings need to be in a format that npm can read.
For details on how .npmrc files are loaded, see the pnpm config command.
For settings that can be configured in pnpm-workspace.yaml, see Settings (pnpm-workspace.yaml).
Registry Settings
registry
- デフォルト: https://registry.npmjs.org/
- タイプ: url
npm パッケージレジストリのベースURL (末尾のスラッシュを含む)。
@jsr:registry
Added in: v10.9.0
- Default: https://npm.jsr.io/
- タイプ: url
The base URL of the JSR package registry.
<scope>:registry
特定のスコープのパッケージに対して使うレジストリ。 例えば、 @babel:registry=https://example.com/packages/npm/ を設定すると、pnpm add @babel/core やその他の @babel スコープのパッケージをインストールする際に、デフォルトのレジストリの代わりに https://example.com/packages/npm を使うように強制します。
Authentication Settings
<URL>:_authToken
レジストリにアクセスするときに使用する認証用の Bearer トークンを指定します。 例:
//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
環境変数を使用することもできます。 例:
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
あるいは、 .npmrc をまったく変更せずに、環境変数を直接使用することもできます。
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
<URL>:tokenHelper
tokenHelper とは、アクセストークンを出力する実行ファイルです。 これは、authToken が一定値ではなく定期的に更新されるような場合に使用します。 スクリプトやその他のツールが、既存のリフレッシュトークンを使って新しいアクセストークンを取得できるようになります。
helper へのパスの設定は、引数なしの絶対パスである必要があります。 安全性を高めるため、この値はユーザーの .npmrc にのみ設定することが許されています。 そうしないと、プロジェクトがプロジェクトのローカルの .npmrc に値を置いて、任意の実行ファイルを実行することができてしまいます。
デフォルトのレジストリに tokenHelper を設定します:
tokenHelper=/home/ivan/token-generator
指定されたレジストリに tokenHelper を設定します:
//registry.corp.com:tokenHelper=/home/ivan/token-generator
Proxy Settings
https-proxy
- デフォルト: null
- タイプ: url
送信する HTTPS リクエストに使用するプロキシ。 HTTPS_PROXY、 https_proxy、 HTTP_PROXY 、または http_proxy 環境変数が設定されている場合は、その値が代わりに使用されます。
プロキシ URL にユーザー名とパスワードが含まれている場合は、必ず URL エンコードしてください。 例:
https-proxy=https://use%21r:pas%2As@my.proxy:1234/foo
ユーザー名とパスワードの間のコロン (:) をエンコードしないでください。
http-proxy
proxy
- デフォルト: null
- タイプ: url
送信する HTTP リクエストに使用するプロキシ。 HTTP_PROXY または http_proxy 環境変数が設定されている場合、プロキシー設定は、内部のリクエストライブラリーに受け渡されます。
local-address
- デフォルト: undefined
- タイプ: IP Address
npm レジストリへの接続を行うときに使用するローカルインターフェイスのIPアドレス。
maxsockets
- Default: networkConcurrency x 3
- タイプ: Number
origin (protocol/host/port の組み合わせ) ごとに使用する最大接続数です。
noproxy
- デフォルト: null
- タイプ: String
プロキシーを使わない TLD をコンマ区切りの文字列で指定します。
SSL Settings
strict-ssl
- デフォルト: true
- タイプ: Boolean
HTTPS 経由でレジストリにリクエストを送る際にSSL鍵の検証を行うかどうかを指定します。
ca オプションも参照してください。
Certificate Settings
ca
- デフォルト: npm CA 証明書
- タイプ: String, Array, null
レジストリへのSSL接続をするのに信用する署名用CA証明書を指定します。 値は PEM フォーマット (Base64エンコードされた X.509 (.CER)) で指定します。 例:
ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
Null に設定すると、既知の登録者のみを許可できます。もしくは、特定の CA 証明書の署名のみを信頼するように設定できます。
証明書の配列を指定することで、複数の信頼する CA を指定することもできます。
ca[]="..."
ca[]="..."
strict-ssl も参照してください。
cafile
- デフォルト: null
- タイプ: path
ひとつ、もしくは複数のCA 署名用証明書を持つファイルへのパスを指定します。 ca 設定と同様ですが、複数の CA に関する情報を CLI 経由ではなくファイルに保持しておくことができます。
<URL>:cafile
Define the path to a Certificate Authority file to use when accessing the specified registry. 例:
//registry.npmjs.org/:cafile=ca-cert.pem
<URL>:ca
Added in: v10.25.0
Define an inline Certificate Authority certificate for the specified registry. The value must be PEM-encoded, like the global ca setting, but it only applies to the matching registry URL.
//registry.example.com/:ca=-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----
cert
- デフォルト: null
- タイプ: String
レジストリにアクセスするときに渡すクライアント証明書。 値は PEM フォーマット (Base64エンコードされた X.509 (.CER)) で指定します。 例:
cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
It is not the path to a certificate file.
<URL>:cert
Added in: v10.25.0
Define an inline client certificate to use when accessing the specified registry. 例:
//registry.example.com/:cert=-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----
<URL>:certfile
Define the path to a certificate file to use when accessing the specified registry. 例:
//registry.npmjs.org/:certfile=server-cert.pem
key
- デフォルト: null
- タイプ: String
レジストリにアクセスするときに渡すクライアントキー。 値は PEM フォーマット (Base64エンコードされた X.509 (.CER)) で指定します。 例:
key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
It is not the path to a key file. Use <URL>:keyfile if you need to reference the file system instead of inlining the key.
この設定には機密情報が含まれています。 リポジトリにコミットされたローカルの .npmrc ファイルに書き込まないでください。
<URL>:key
Added in: v10.25.0
Define an inline client key for the specified registry URL.
//registry.example.com/:key=-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----
<URL>:keyfile
Define the path to a client key file to use when accessing the specified registry. 例:
//registry.npmjs.org/:keyfile=server-key.pem