Skip to content

Update README to refer to blocklist and allowlist #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
route merged 1 commit into from
Feb 1, 2025
Merged

Update README to refer to blocklist and allowlist #290

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,24 +190,26 @@ Besides capybara screenshot method you can get image as Base64:
* `page.driver.set_proxy(ip, port, user, password)`


## URL Blacklisting & Whitelisting
## URL Block/Allowlisting

Cuprite supports URL blacklisting, which allows you to prevent scripts from
Cuprite supports URL blocklisting, which allows you to prevent scripts from
running on designated domains:

```ruby
page.driver.browser.url_blacklist = %r{http://www.example.com}
page.driver.browser.url_blocklist = %r{http://www.example.com}
```

and also URL whitelisting, which allows scripts to only run on designated
and also URL allowlisting, which allows scripts to only run on designated
domains:

```ruby
page.driver.browser.url_whitelist = %r{http://www.example.com}
page.driver.browser.url_allowlist = %r{http://www.example.com}
```

If you are experiencing slower run times, consider creating a URL whitelist of
domains that are essential or a blacklist of domains that are not essential,
For legacy support, `url_blacklist=` and `url_whitelist=` continue to work respextively

If you are experiencing slower run times, consider creating a URL allowlist of
domains that are essential or a blocklist of domains that are not essential,
such as ad networks or analytics, to your testing environment.

## License
Expand Down
Loading