User Data Storage

If you need to run your browsers and persist the user data between sessions. You need to use a S3 service.

You can use any S3 compatible service like Cloudflare R2, Rustfs, AWS S3, Backblaze, etc...

Quick Start

To run BlitzBrowser locally with user data storage. We created a docker-compose file with our docker image and with the Rustfs docker image.

1. First, deploy the docker-compose file.
2. When it is running, you need to create the bucket user-data in Rustfs http://localhost:9001.
3. You are now ready to persist the user data of your browsers.

Docker compose

services:
  blitzbrowser:
    image: ghcr.io/blitzbrowser/blitzbrowser:latest
    ports:
      - "9999:9999"
    environment:
      S3_ENDPOINT: http://s3:9000
      S3_ACCESS_KEY_ID: rustfsadmin
      S3_SECRET_ACCESS_KEY: rustfsadmin
      S3_USER_DATA_BUCKET: user-data
    shm_size: "2gb"
    restart: always
  s3:
    image: rustfs/rustfs
    ports:
      - "9000:9000"
      - "9001:9001"
    environment:
      RUSTFS_VOLUMES: /data
      RUSTFS_ADDRESS: :9000
      RUSTFS_ACCESS_KEY: rustfsadmin
      RUSTFS_SECRET_KEY: rustfsadmin
      RUSTFS_CONSOLE_ENABLE: true
    restart: always
    volumes:
      - s3_data:/data
  # RustFS volume permissions fixer service
  volume-permission-helper:
    image: alpine
    volumes:
      - s3_data:/data
    command: >
      sh -c "
        chown -R 10001:10001 /data &&
        echo 'Volume Permissions fixed' &&
        exit 0
      "
    restart: "no"
volumes:
  s3_data:

Connect your code

To connect to a browser and to persist the user data. You need to use the userDataId=${ID} property in the CDP URL. Check the Chrome DevTools Protocol properties to learn how to configure your browser.

Puppeteer

import puppeteer from 'puppeteer';

const browser = await puppeteer.connect({
    browserWSEndpoint: `ws://localhost:9999?userDataId=myFirstUserData`
});

const context = await browser.createBrowserContext();
const page = await context.newPage();

// ...

await browser.close();

Playwright + NodeJS

import { chromium } from 'playwright';

const browser = await chromium.connectOverCDP(`ws://localhost:9999?userDataId=myFirstUserData`);

const context = await browser.newContext();
const page = await context.newPage();

// ...

await browser.close();