Browserless

Browserless Web is communication between web applications without the need for a web browser.

Official integration

Created 4 years ago - Last update 4 years ago

Browserless Web is communication between web applications without the need for a web browser.

Deployed services

browserless

browserless/chrome:$$cap_browserless_version

browserless-workspace:/downloads
browserless-metrics:/metrics
browserless-user-data:/user-data

3000

always

Variables

Browserless Version

Default: 1-chrome-stable

$$cap_browserless_version
Browserless Image Version

Demo Mode

Default: false

$$cap_demo_mode
If you want to serve the interactive debugger, but not allow it to handle puppeteer.connect calls, you can do so via the DEMO_MODE flag.

Enable Debugger

Default: true

$$cap_enable_debugger
If you want to disable the debugger (and all accompnaying HTML) you can set the ENABLE_DEBUGGER to false to only allow puppeteer.connect calls to succeed.

Max Concurrent Sessions

Default: 5

$$cap_max_concurrent_sessions
Since running Chrome can be rather resource intensive you'll probably want to limit the number of concurrent sessions. This is, by default, set to 5 when not specified. Once the limit is reached then queueing begins to take place and requests will wait until more workers are ready.

Connection Timeout

Default: 30000

$$cap_connection_timeout
Connection timeout is a parameter that sets how long any session can run for. This is in place to prevent scripts that don't cleanup properly, or run into errors tha cause them to hang. The value of which can be set in milliseconds, and defaults to 30000, or 30 seconds.

Max Queue Length

Default: 5

$$cap_max_queue_length
This value determines how many items in the queue are allowed before requests are issued a 429 response code and closed.

workspace location

Default: /downloads

$$cap_workspace_dir
Defining a workspace location

Deleting workspace files automatically

Default: false

$$cap_workspace_delete_expired
When downloads from Chrome are larger, it's easy for the docker image to fill it's disk-space if you forget to periodically delete files.

time to delete workspace files

Default: 30

$$cap_workspace_expire_days
When WORKSPACE_DELETE_EXPIRED is true, browserless attempts to delete files older than 30 days in the workspace directory.

User Data Dir

Default: /user-data

$$cap_default_user_data_dir
Sets a default directory to cache user data to (cookies, local-storage and more).

Persisting Metrics

Default: /metrics/metrics.json

$$cap_metrics_json_path
browserless captures metrics while it's running, and exposes them via the /metrics endpoint.

Disable download behavior

Default: false

$$cap_disable_auto_set_download_behavior
By default, browserless tells chromium to use a special directory in /tmp for storing files. If you want opt-out of this behavior, set to true

Block Ads

Default: false

$$cap_default_block_ads
Starts all sessions with the ad-blocker already running

Enable API GET

Default: true

$$cap_enable_api_get
Allows for enabling an expiremental GET-style operation, as opposed to POSTing bodies of code to run on our APIs.

Token

Default: $$cap_gen_random_hex(32)

$$cap_token
If you're exposing your instance to the world, but don't want anyone to use it, you can optionally apply a TOKEN param that will restrict calls without a token query-string parameter.

Enable CORS

Default: true

$$cap_enable_cors
You can enable cross-origin-resource-sharing with browserless

Enable XVFB

Default: true

$$cap_enable_xvbf
in some hosting environments it's not possible to write to the appropriate folders to support XVFB and you should set this parameter to false.

Exit on health failure

Default: true

$$cap_exit_on_health_failure
In order for browserless to restart on health-failure checks, you'll have to set to true.

Ignore HTTPS errors

Default: true

$$cap_default_ignore_https_errors
Tells browserless to, by default, ignore or not ignore HTTPS errors on sites.

Ignore Default Args

Default: false

$$cap_default_ignore_default_args
When set this will override any default arguments set by browserless to Chrome's launch arguments

Disable Routes

Default:

$$cap_disabled_features
Allows for disabling routes by supplying a list of routes to disable

Pre-booting Chrome

Default: false

$$cap_preboot_chrome
You can, optionally, pre-boot Chrome and keep it in a pool of instances (determined by MAX_CONCURRENT_SESSIONS) in order to cut-down on the boot time.

Keeping Chrome Alive

Default: false

$$cap_keep_alive
When the PREBOOT_CHROME flag is set, you can optionally keep Chrome "alive" after sessions are complete. This allows you to re-use Chrome instances without having to start and stop them (making for much faster execution).

Chrome Refresh Time

Default: 3600000

$$cap_chrome_refresh_time
When both PREBOOT_CHROME and KEEP_ALIVE are true browserless keeps track of how long Chrome has been running, and will attempt to close it after a certain period.

Function Incognito Mode

Default: false

$$cap_function_enable_incognito_mode
When set, and PREBOOT_CHROME and KEEP_ALIVE are set, allows for generating a fresh page (incognito page) from a re-used browser.