Skip to content

Commit bfdaf24

Browse files
authored
Rework Docker prerequisites (#5862)
* Rework Docker prerequisites * correct statement about unzip with Node.js
1 parent 59407f1 commit bfdaf24

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

docs/guides/getting-started/installing-cypress.mdx

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Please read our
141141
[Continuous Integration](/guides/continuous-integration/introduction) docs for
142142
help installing Cypress in CI. When running in Linux you may need to install some
143143
[system dependencies](#Linux-Prerequisites)
144-
or you can use our [Docker images](/examples/docker) which have everything you
144+
or you can use our [Docker images](#Docker-Prerequisites) which have everything you
145145
need prebuilt.
146146

147147
## System requirements
@@ -203,7 +203,7 @@ requirements:
203203
If you're using Linux, you'll want to have the required dependencies installed
204204
on your system. Depending on your system defaults, these dependencies may already be installed.
205205
If not, run the command line for your operating system listed below.
206-
[Cypress Docker images](#Docker), which are Debian-based, already include the necessary dependencies.
206+
See below under [Docker Prerequisites](#Docker-Prerequisites) for information on [Cypress Docker images](https://github.com/cypress-io/cypress-docker-images). These already include the necessary dependencies.
207207

208208
#### Ubuntu/Debian
209209

@@ -229,25 +229,20 @@ pacman -S gtk2 gtk3 alsa-lib xorg-server-xvfb libxss nss libnotify
229229
dnf install -y xorg-x11-server-Xvfb gtk3-devel nss alsa-lib
230230
```
231231

232-
#### Docker
232+
### Docker Prerequisites
233233

234-
Docker images with all of the required dependencies installed are available
235-
under [cypress/base](https://github.com/cypress-io/cypress-docker-images)
234+
[Cypress Docker images](../continuous-integration/introduction#Cypress-Docker-variants) are available from
235+
[Docker Hub](https://hub.docker.com/u/cypress) and the
236+
[Amazon ECR (Elastic Container Registry) Public Gallery](https://gallery.ecr.aws/cypress-io).
237+
These images, which are Linux (Debian) based, include all of the required dependencies pre-installed.
236238

237-
If you're running your projects in containers, then you'll want Cypress in the
238-
container with the Node.js process.
239+
If you need Node.js, browser or Cypress version combinations which are not covered by the published Cypress Docker images,
240+
then the [cypress/factory](https://github.com/cypress-io/cypress-docker-images/tree/master/factory) image
241+
allows you to generate your own customized Docker image easily.
239242

240-
```
241-
ui:
242-
image: cypress/base:latest
243-
# if targeting a specific node version, use e.g.
244-
# image: cypress/base:20.14.0
245-
```
246-
247-
`cypress/base` is a drop-in replacement for
248-
[base docker node images](https://hub.docker.com/_/node/).
249-
250-
**Great, now [install Cypress](#Installing)!**
243+
If you are not using a Cypress Docker image, make sure that your base operating system is a Linux system listed in the supported
244+
[Operating Systems](#Operating-System) above and that Node.js is installed in the image.
245+
It is recommended to have `unzip` installed. This avoids the Cypress binary installation falling back to a slower unzip method using Node.js.
251246

252247
## Next Steps
253248

0 commit comments

Comments
 (0)