Passer au contenu principal

Installation

Node.js 20 ou version ultérieure est requis. La version 3 du SDK est uniquement ESM : chargez-la avec import, car require('gologin') ne fonctionne pas.

Utilisation de base

Lancer avec GologinApi

GologinApi démarre un profil et connecte Puppeteer à votre place. launch() renvoie un browser Puppeteer. Passez cloud: true pour exécuter le profil dans Gologin Cloud Browser plutôt que dans un navigateur Orbita local :
Sans profileId, launch() commence par créer un nouveau profil. GologinApi propose également des fonctions utilitaires telles que createProfileRandomFingerprint(), addGologinProxyToProfile(), addCookiesToProfile() et deleteProfile(). Consultez le Guide de démarrage rapide pour un exemple complet.

Paramètres principaux

Arrêter des profils

Fermez d’abord le navigateur dans votre outil d’automatisation, par exemple avec browser.close(). stop() n’accepte aucune option et envoie toujours le profil vers Gologin. stopLocal({ posting: false }) termine la session sans envoyer les données du profil. Utilisez-le sur les serveurs où vous ne souhaitez pas de synchronisation avec le cloud. Les cookies sont tout de même envoyés si vous avez défini uploadCookiesToServer: true.

Gérer les versions du navigateur Orbita

Au démarrage d’un profil, le SDK vérifie quelle version d’Orbita correspond à l’user agent du profil. Si cette version ne se trouve pas encore dans ~/.gologin/browser, le SDK la télécharge ; sinon, il réutilise la copie déjà installée. Pour exécuter une version précise, passez executablePath. Les options autoUpdateBrowser (false par défaut) et checkBrowserUpdate sont toujours acceptées, mais dans le SDK actuel (3.0.7), elles ne modifient pas ce comportement. Pour télécharger Orbita à l’avance, appelez checkAndDownloadBrowserByOpts() sur une instance de GoLogin. Il s’agit d’une méthode, et non d’un export distinct :
Sans options, elle télécharge les 5 dernières versions. Utilisez-la avant de lancer des profils en parallèle afin d’éviter plusieurs téléchargements simultanés.

Exécuter plus de 100 profils en parallèle

Lorsque vous exécutez de nombreux profils simultanément sur un serveur :
Points importants pour les serveurs :
  • Limitez le nombre de lancements de profils simultanés (10 à 20 recommandés pour commencer)
  • Téléchargez les versions d’Orbita à l’avance, avant de lancer les profils
  • Sous Linux : installez Xvfb et définissez DISPLAY=:99
  • Augmentez les limites de descripteurs de fichiers : ulimit -n 65536
  • Surveillez la RAM : chaque profil utilise environ 300 à 500 Mo

Débogage

Définissez la variable d’environnement pour activer les journaux détaillés :

GitHub et journal des modifications