Skip to content

Add geckodriver information #6196

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.

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
Merged
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions docs/app/references/launching-browsers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,34 @@ of our [docker images](/app/continuous-integration/overview#Cypress-Docker-Image
By default, we will launch Firefox headlessly during `cypress run`. To run
Firefox headed, you can pass the `--headed` argument to `cypress run`.

##### Mozilla geckodriver

Cypress requires the
[Mozilla geckodriver](https://github.com/mozilla/geckodriver) to launch Firefox.
To meet this requirement, the Cypress binary uses the separate npm wrapper package
[geckodriver](https://github.com/webdriverio-community/node-geckodriver)
to provide the Mozilla geckodriver.
The wrapper downloads the latest driver version if it does not find any driver version cached locally.

:::info

Retrieving the driver may fail if you are operating Cypress in an air-gapped environment without Internet connectivity and you do not have a cached driver version available.

To avoid this issue, use a current
[Cypress Docker image](/app/continuous-integration/overview#Cypress-Docker-Images) `cypress/browsers` or `cypress/included`, built with Firefox 139, or above.
These images include a Mozilla geckodriver version pre-installed.
Using `cypress/factory:5.9.0`, or above, you can also build your own custom Cypress Docker image that includes a Mozilla geckodriver version.
Refer to the `cypress/factory`
[documentation](https://github.com/cypress-io/cypress-docker-images/blob/master/factory/README.md) for instructions on building custom images.

If you need to work without Docker, refer to the npm wrapper package geckodriver
[documentation](https://github.com/webdriverio-community/node-geckodriver) for information
about how to define a custom path for the driver or how to refer to a local CDN mirror site.
Download the Mozilla geckodriver from the
[releases](https://github.com/mozilla/geckodriver/releases) location.

:::

##### Webdriver BiDi and CDP Deprecation

:::info
Expand Down