跳转到主要内容

安装

需要 Node.js 20 或更高版本。SDK 的第 3 版仅支持 ESM:请使用 import 加载,require('gologin') 无法使用。

基本用法

使用 GologinApi 启动

GologinApi 会为你启动配置文件并连接 Puppeteer。launch() 会返回一个 Puppeteer browser。传入 cloud: true 可让配置文件在 Gologin Cloud Browser 中运行,而不是在本地的 Orbita 浏览器中运行:
如果不传 profileId,launch() 会先创建一个新的配置文件。GologinApi 还提供了一些辅助方法,例如 createProfileRandomFingerprint()、addGologinProxyToProfile()、addCookiesToProfile() 和 deleteProfile()。完整示例请参阅快速入门。

主要参数

停止配置文件

请先在自动化工具中关闭浏览器,例如使用 browser.close()。stop() 不接受任何选项,并且始终会将配置文件上传到 Gologin。stopLocal({ posting: false }) 会结束会话,但不上传配置文件数据,适用于不希望进行云端同步的服务器。如果你设置了 uploadCookiesToServer: true,Cookie 仍然会被上传。

管理 Orbita 浏览器版本

配置文件启动时,SDK 会检查该配置文件的 user agent 需要哪个版本的 Orbita。如果 ~/.gologin/browser 中还没有该版本,SDK 会自动下载;否则会直接使用已安装的版本。如需运行指定的版本,请传入 executablePath。autoUpdateBrowser(默认为 false)和 checkBrowserUpdate 选项仍可传入,但在当前 SDK(3.0.7)中,它们不会改变上述行为。 如需提前下载 Orbita,请在 GoLogin 实例上调用 checkAndDownloadBrowserByOpts()。它是一个方法,而不是单独的导出:
如果不传入选项,它会下载最新的 5 个版本。在并行启动配置文件之前使用它,可以避免同时进行多个下载。

并行运行 100 个以上的配置文件

在服务器上同时运行大量配置文件时:
服务器使用注意事项:
  • 限制同时启动的配置文件数量(建议从 10-20 个开始)
  • 在启动之前预先下载 Orbita 版本
  • 在 Linux 上:安装 Xvfb 并设置 DISPLAY=:99
  • 提高文件描述符限制:ulimit -n 65536
  • 监控内存:每个配置文件约占用 300-500 MB

调试

设置环境变量以输出详细日志:

GitHub 与更新日志