Skip to content

Commit

Permalink
docs: README usage with sandbox setting
Browse files Browse the repository at this point in the history
  • Loading branch information
liuminhaw committed Dec 24, 2023
1 parent 80acf91 commit 9ac5c42
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ RendererContext values:
- `BrowserExecPath`: Manually set chrome / chromium browser's executable path
- Type: String
- Default: Empty string (Auto detect)
- `NoSandbox`: Set to disable using sandbox for isolating browser process (usually use in docker container or AWS lambda)
- Type: bool
- Default: false

### Example
See usage example at [examples](examples/render/main.go)
Expand All @@ -54,6 +57,8 @@ Usage of ./render:
how to determine loading idle and return, valid input: networkIdle, InteractiveTime (default "networkIdle")
-imageLoad
indicate if load image when rendering
-sandbox
indicate if using sandbox for isolating browser process (default true)
-skipFrameCount int
skip first n frames with same id as init frame, only valid with idleType=networkIdle
-timeout int
Expand Down Expand Up @@ -92,6 +97,9 @@ PdfContext values:
- `BrowserExecPath`: Manually set chrome / chromium browser's executable path
- Type: String
- Default: Empty string (Auto detect)
- `NoSandbox`: Set to disable using sandbox for isolating browser process (usually use in docker container or AWS lambda)
- Type: bool
- Default: false

### Example
See usage example at [examples](examples/pdf/main.go)
Expand Down Expand Up @@ -124,6 +132,8 @@ Usage of ./pdf.out:
paper height in centimeter
-paperWidth float
paper width in centimeter
-sandbox
indicate if using sandbox for isolating browser process (default true)
```


0 comments on commit 9ac5c42

Please sign in to comment.