メインコンテンツへスキップ

インストール

Node.js 20以降が必要です。SDKのバージョン3はESM専用です。importで読み込んでください。require('gologin')は使用できません。

基本的な使い方

GologinApiで起動する

GologinApiは、プロファイルを起動してPuppeteerへの接続まで自動で行います。launch()はPuppeteerのbrowserを返します。cloud: trueを指定すると、ローカルのOrbitaブラウザではなくGologin Cloud Browserでプロファイルを実行できます。
profileIdを指定しない場合、launch()は最初に新しいプロファイルを作成します。GologinApiには、createProfileRandomFingerprint()、addGologinProxyToProfile()、addCookiesToProfile()、deleteProfile()などのヘルパーも用意されています。完全なサンプルはクイックスタートをご覧ください。

主なパラメーター

プロファイルの停止

まず、自動化ツール側でbrowser.close()などを使ってブラウザを閉じてください。stop()はオプションを受け取らず、常にプロファイルをGologinへアップロードします。stopLocal({ posting: false })は、プロファイルデータをアップロードせずにセッションを終了します。クラウド同期が不要なサーバーで使用してください。uploadCookiesToServer: trueを設定している場合、Cookieは引き続きアップロードされます。

Orbitaブラウザのバージョン管理

プロファイルの起動時に、SDKはプロファイルのユーザーエージェントに必要な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
  • RAMを監視してください。1プロファイルあたり約300〜500 MBを使用します

デバッグ

詳細なログを出力するには、次の環境変数を設定します。

GitHubと変更履歴