From 11d62d84f3559ad476e2c218b555cd3f1e3be874 Mon Sep 17 00:00:00 2001 From: j_r0dd <285797+jr0dd@users.noreply.github.com> Date: Tue, 15 Feb 2022 14:37:36 -0500 Subject: [PATCH] [puppeteer] update readme (#1415) --- charts/stable/puppeteer/Chart.yaml | 4 ++-- .../stable/puppeteer/README_CONFIG.md.gotmpl | 20 ++++++++++++++++++- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/charts/stable/puppeteer/Chart.yaml b/charts/stable/puppeteer/Chart.yaml index e339c3f9..dbf7dae1 100644 --- a/charts/stable/puppeteer/Chart.yaml +++ b/charts/stable/puppeteer/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: v13.3.2 description: Headless Chrome Node.js API name: puppeteer -version: 1.0.0 +version: 1.0.1 kubeVersion: ">=1.16.0-0" keywords: - puppeteer @@ -24,4 +24,4 @@ dependencies: annotations: artifacthub.io/changes: | - kind: changed - description: Upgraded `common` chart dependency to version `4.3.0`. + description: Updated README. diff --git a/charts/stable/puppeteer/README_CONFIG.md.gotmpl b/charts/stable/puppeteer/README_CONFIG.md.gotmpl index 65e23b3e..ed8d77e1 100644 --- a/charts/stable/puppeteer/README_CONFIG.md.gotmpl +++ b/charts/stable/puppeteer/README_CONFIG.md.gotmpl @@ -1,11 +1,18 @@ {{- define "custom.custom.configuration.header" -}} -## Sample code to connect to Puppeteer +## Special Instructions {{- end -}} {{- define "custom.custom.configuration" -}} {{ template "custom.custom.configuration.header" . }} +### **Important!** +```console +You may need special headers to connect from outside of the cluster. Intra cluster works fine. ``` + +### Sample code to connect to Puppeteer + +```javascript const puppeteer = require('puppeteer-core') const dns = require('dns').promises; @@ -29,4 +36,15 @@ const dns = require('dns').promises; }) })() ``` + +### Default chromium flags in image + +```javascript +'--disable-dev-shm-usage', +'--disable-setuid-sandbox', +'--no-sandbox', +'--remote-debugging-address=0.0.0.0', +'--remote-debugging-port=4000', +'--user-agent=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/ 85.0.4183.121 Safari/537.36' +``` {{- end -}}