@blitzbrowser/blitzbrowser 1.1.2 → 1.1.4

package/.github/workflows/cicd.yml

@@ -0,0 +1,49 @@
+name: CI/CD
+on:
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  contents: read
+  packages: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: latest
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'pnpm'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build
+      - run: pnpm publish --access public --no-git-checks
+      - id: package_version
+        run: echo "VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
+      - uses: actions/github-script@v8
+        with:
+          script: |
+            github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: 'refs/tags/${{ steps.package_version.outputs.VERSION }}',
+              sha: context.sha
+            })
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/setup-buildx-action@v3
+      - uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository }}:latest
+            ghcr.io/${{ github.repository }}:${{ steps.package_version.outputs.VERSION }}

package/Dockerfile

@@ -23,4 +23,6 @@ COPY ./tsconfig.json ./tsconfig.json
 
 RUN npm run build
 
-ENTRYPOINT ["tini", "--"]
+ENTRYPOINT ["tini", "--"]
+
+CMD ["node", "./dist/main.js"]

package/README.md

@@ -1 +1,116 @@
-# BlitzBrowser
+# BlitzBrowser
+
+## 🚀 Quick Start
+
+Start in seconds with docker and then connect your code.
+
+### Docker
+
+```bash
+docker run -p=9999:9999 --shm-size=2g ghcr.io/blitzbrowser/blitzbrowser:latest
+```
+
+<details>
+<summary><b>Docker Compose</b></summary>
+
+```yaml
+services:
+  blitzbrowser:
+    image: ghcr.io/blitzbrowser/blitzbrowser:latest
+    ports:
+      - "9999:9999"
+    shm_size: "2gb"
+    restart: always
+```
+
+</details>
+
+<details>
+<summary><b>Docker Compose with Rustfs (User Data Storage)</b></summary>
+
+Before using user data storage with BlitzBrowser. You need to create the bucket `user-data` in Rustfs [http://localhost:9001](http://localhost:9001).
+
+```yaml
+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:
+```
+
+</details>
+
+### Connect your code
+
+<details open>
+<summary><b>Puppeteer</b></summary>
+
+```typescript
+import puppeteer from 'puppeteer';
+
+const browser = await puppeteer.connect({
+    browserWSEndpoint: `ws://localhost:9999`
+});
+
+const context = await browser.createBrowserContext();
+const page = await context.newPage();
+
+// ...
+
+await browser.close();
+```
+
+</details>
+
+<details>
+<summary><b>Playwright + NodeJS</b></summary>
+
+```typescript
+import { chromium } from 'playwright';
+
+const browser = await chromium.connectOverCDP(`ws://localhost:9999`);
+
+const context = await browser.newContext();
+const page = await context.newPage();
+
+// ...
+
+await browser.close();
+```
+
+</details>

package/dist/app.module.js

@@ -14,6 +14,23 @@ const user_data_service_1 = require("./services/user-data.service");
 const browser_pool_service_1 = require("./services/browser-pool.service");
 const timezone_service_1 = require("./services/timezone.service");
 const cdp_controller_1 = require("./controllers/cdp.controller");
+const USER_DATA_PROVIDERS = Object.keys(process.env).filter(k => k.startsWith('S3_')).length === 0 ? [] : [
+    {
+        provide: client_s3_1.S3Client,
+        useFactory: async () => {
+            return new client_s3_1.S3Client({
+                region: 'auto',
+                endpoint: process.env.S3_ENDPOINT,
+                credentials: {
+                    accessKeyId: process.env.S3_ACCESS_KEY_ID,
+                    secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
+                },
+                forcePathStyle: true,
+            });
+        }
+    },
+    user_data_service_1.UserDataService,
+];
 let AppModule = class AppModule {
 };
 exports.AppModule = AppModule;
@@ -25,21 +42,7 @@ exports.AppModule = AppModule = __decorate([
             status_controller_1.StatusController,
         ],
         providers: [
-            {
-                provide: client_s3_1.S3Client,
-                useFactory: async () => {
-                    return new client_s3_1.S3Client({
-                        region: 'auto',
-                        endpoint: process.env.S3_ENDPOINT,
-                        credentials: {
-                            accessKeyId: process.env.S3_ACCESS_KEY_ID,
-                            secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
-                        },
-                        forcePathStyle: true,
-                    });
-                }
-            },
-            user_data_service_1.UserDataService,
+            ...USER_DATA_PROVIDERS,
             browser_pool_service_1.BrowserPoolService,
             timezone_service_1.TimezoneService
         ],

package/dist/app.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.module.js","sourceRoot":"","sources":["../src/app.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,kDAA8C;AAC9C,uEAAmE;AACnE,oEAA+D;AAC/D,0EAAqE;AACrE,kEAA8D;AAC9D,iEAA6D;AA6BtD,IAAM,SAAS,GAAf,MAAM,SAAS;CAAI,CAAA;AAAb,8BAAS;oBAAT,SAAS;IA3BrB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,EAAE;QACX,WAAW,EAAE;YACX,8BAAa;YACb,oCAAgB;SACjB;QACD,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,oBAAQ;gBACjB,UAAU,EAAE,KAAK,IAAI,EAAE;oBACrB,OAAO,IAAI,oBAAQ,CAAC;wBAClB,MAAM,EAAE,MAAM;wBACd,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;wBACjC,WAAW,EAAE;4BACX,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB;4BACzC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB;yBAClD;wBACD,cAAc,EAAE,IAAI;qBACrB,CAAC,CAAC;gBACL,CAAC;aACF;YAED,mCAAe;YACf,yCAAkB;YAClB,kCAAe;SAChB;KACF,CAAC;GACW,SAAS,CAAI"}
+{"version":3,"file":"app.module.js","sourceRoot":"","sources":["../src/app.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,kDAA8C;AAC9C,uEAAmE;AACnE,oEAA+D;AAC/D,0EAAqE;AACrE,kEAA8D;AAC9D,iEAA6D;AAE7D,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxG;QACE,OAAO,EAAE,oBAAQ;QACjB,UAAU,EAAE,KAAK,IAAI,EAAE;YACrB,OAAO,IAAI,oBAAQ,CAAC;gBAClB,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;gBACjC,WAAW,EAAE;oBACX,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB;oBACzC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB;iBAClD;gBACD,cAAc,EAAE,IAAI;aACrB,CAAC,CAAC;QACL,CAAC;KACF;IAED,mCAAe;CAChB,CAAA;AAcM,IAAM,SAAS,GAAf,MAAM,SAAS;CAAI,CAAA;AAAb,8BAAS;oBAAT,SAAS;IAZrB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,EAAE;QACX,WAAW,EAAE;YACX,8BAAa;YACb,oCAAgB;SACjB;QACD,SAAS,EAAE;YACT,GAAG,mBAAmB;YACtB,yCAAkB;YAClB,kCAAe;SAChB;KACF,CAAC;GACW,SAAS,CAAI"}