跳到主要内容
版本：22.5.0

配置

Puppeteer 中的所有默认值可以通过两种方式自定义

  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'),
};
注意

请注意，这仅适用于 CommonJS 配置文件，因为需要有关环境的信息（在本例中为 __dirname）。

环境变量​

除了配置文件之外，Puppeteer 还会查找某些 环境变量 以自定义行为。在适用时，环境变量将始终覆盖配置文件选项。

以下选项为仅限环境选项

  • HTTP_PROXY、HTTPS_PROXY、NO_PROXY - 定义用于下载和运行浏览器的 HTTP 代理设置。

所有其他选项都可以在 Configuration 接口的文档中找到。