These images provide all of the required dependencies for running Cypress in Docker.
We build three main images, click on the image name to see the available tags and versions.
| Image | Default | Description | Monthly pulls |
|---|---|---|---|
| cypress/base | cypress/base:8 |
All system dependencies, no browsers. |  |
| cypress/browsers | cypress/browsers:chrome67 |
All system dependencies and browser(s). |  |
| cypress/included | cypress/included:3.2.0 |
All system dependencies and the Cypress test runner installed globally. |  |
Of these images, we provide multiple tags for various operating systems and specific browser versions. These allow you to target specific combinations you need.
It is recommended to use a specific image tag, and not rely on the default tag. For example, it is better to use cypress/base:8 than cypress/base. Even better it is to use full version of the image, like cypress/base:8.15.1 - we will never overwrite the existing Docker images to prevent accidental changes.
All of the images and tags are published to DockerHub under
- https://hub.docker.com/r/cypress/base
- https://hub.docker.com/r/cypress/browsers
- https://hub.docker.com/r/cypress/included
These images have all dependencies necessary to install and run Cypress. Just install your NPM dependencies (including Cypress) and run the tests. We utilize many of these docker images in our own projects, with different CI providers.
Check out our docs for examples.
If you want to use cypress/included image, read Run Cypress with a single Docker command
Folder examples/included-as-non-root shows how to build a new Docker image on top of cypress/included image and run the tests as non-root user node.
Folder examples/included-as-non-root-alternative shows another approach to allow built-in non-root user node to run tests using cypress/included image.
Folder examples/included-as-non-root-mapped shows how to build a Docker image on top of cypress/included that runs with a non-root user that matches the id of the user on the host machine. This way, the permissions on any files created during the test run match the user's permissions on the host machine.
Folder examples/included-with-plugins shows how to use locally installed Cypress plugins while running cypress/included image.
Some versions of Node restrict running postinstall hook with the following error message
lifecycle realworld@1.0.0~postinstall: cannot run in wd realworld@1.0.0
In that case run install with npm install --unsafe-perm flag, or set an environment variable in the container
npm_config_unsafe_perm: true
When running headed tests with X11 forwarding in Cypress v4 you might see blank Chrome screen. Try disabling memory sharing by setting the following environment variables
export QT_X11_NO_MITSHM=1
export _X11_NO_MITSHM=1
export _MITSHM=0
See issue #270
See CONTRIBUTING.md
See LICENSE