メインコンテンツへスキップ
バージョン: 22.5.0

設定

Puppeteerのすべてのデフォルトは、次の2つの方法でカスタマイズできます。

  1. 設定ファイル推奨
  2. 環境変数
注意

一部のオプション(HTTPS_PROXYなど)は、環境変数でのみカスタマイズできることに注意してください。

注意

Puppeteerの設定ファイルと環境変数は、puppeteer-coreでは無視されます。

設定ファイル

設定ファイルは、Puppeteerを構成するための推奨される選択肢です。Puppeteerは、次のいずれかの形式のファイルツリーを検索します。

  • .puppeteerrc.cjs,
  • .puppeteerrc.js,
  • .puppeteerrc(YAML/JSON)、
  • .puppeteerrc.json,
  • .puppeteerrc.yaml,
  • puppeteer.config.js、および
  • puppeteer.config.cjs

Puppeteerは、アプリケーションのpackage.jsonからpuppeteerキーも読み取ります。

可能なオプションについては、Configurationインターフェースを参照してください。

注意

設定ファイルを追加した後、変更がインストールに影響する場合は、有効にするためにpuppeteerを削除して再インストールする必要がある場合があります。

デフォルトのキャッシュディレクトリの変更

v19.0.0以降、Puppeteerはインストール間でブラウザをグローバルにキャッシュするために~/.cache/puppeteerにブラウザを保存します。puppeteerが一部のビルドステップでパックされ、新しい場所に移動した場合、これにより問題が発生する可能性があります。次の設定でこの問題を解決できます(有効にするにはpuppeteerを再インストールしてください)。

project-directory/.puppeteerrc.cjs
const {join} = require('path');

/**
* @type {import("puppeteer").Configuration}
*/
module.exports = {
// Changes the cache location for Puppeteer.
cacheDirectory: join(__dirname, '.cache', 'puppeteer'),
};
注意

これは、周囲の環境に関する情報が必要なため(この場合は__dirname)、CommonJS設定ファイルでのみ可能であることに注意してください。

環境変数

Puppeteerは、設定ファイルに加えて、動作をカスタマイズするための特定の環境変数も検索します。環境変数は、該当する場合、常に設定ファイルのオプションを上書きします。

次のオプションは、環境のみのオプションです。

  • HTTP_PROXYHTTPS_PROXYNO_PROXY - ブラウザをダウンロードして実行するために使用されるHTTPプロキシ設定を定義します。

その他のすべてのオプションについては、Configurationインターフェースのドキュメントに記載されています。