From 356630222fcedeabb7204f8bae8071b14930ccf5 Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Tue, 2 Jul 2024 11:22:58 +0200 Subject: [PATCH 1/2] Rework Docker prerequisites --- .../getting-started/installing-cypress.mdx | 31 ++++++++----------- 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/docs/guides/getting-started/installing-cypress.mdx b/docs/guides/getting-started/installing-cypress.mdx index cc8adadb4d..9664984392 100644 --- a/docs/guides/getting-started/installing-cypress.mdx +++ b/docs/guides/getting-started/installing-cypress.mdx @@ -141,7 +141,7 @@ Please read our [Continuous Integration](/guides/continuous-integration/introduction) docs for help installing Cypress in CI. When running in Linux you may need to install some [system dependencies](#Linux-Prerequisites) -or you can use our [Docker images](/examples/docker) which have everything you +or you can use our [Docker images](#Docker-Prerequisites) which have everything you need prebuilt. ## System requirements @@ -203,7 +203,7 @@ requirements: If you're using Linux, you'll want to have the required dependencies installed on your system. Depending on your system defaults, these dependencies may already be installed. If not, run the command line for your operating system listed below. -[Cypress Docker images](#Docker), which are Debian-based, already include the necessary dependencies. +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. #### Ubuntu/Debian @@ -235,25 +235,20 @@ yum install -y xorg-x11-server-Xvfb gtk2-devel gtk3-devel libnotify-devel GConf2 dnf install -y xorg-x11-server-Xvfb gtk3-devel nss alsa-lib ``` -#### Docker +### Docker Prerequisites -Docker images with all of the required dependencies installed are available -under [cypress/base](https://github.com/cypress-io/cypress-docker-images) +[Cypress Docker images](../continuous-integration/introduction#Cypress-Docker-variants) are available from +[Docker Hub](https://hub.docker.com/u/cypress) and the +[Amazon ECR (Elastic Container Registry) Public Gallery](https://gallery.ecr.aws/cypress-io). +These images, which are Linux (Debian) based, include all of the required dependencies pre-installed. -If you're running your projects in containers, then you'll want Cypress in the -container with the Node.js process. +If you need Node.js, browser or Cypress version combinations which are not covered by the published Cypress Docker images, +then the [cypress/factory](https://github.com/cypress-io/cypress-docker-images/tree/master/factory) image +allows you to generate your own customized Docker image easily. -``` - ui: - image: cypress/base:latest - # if targeting a specific node version, use e.g. - # image: cypress/base:20.14.0 -``` - -`cypress/base` is a drop-in replacement for -[base docker node images](https://hub.docker.com/_/node/). - -**Great, now [install Cypress](#Installing)!** +If you are not using a Cypress Docker image, make sure that your base operating system is a Linux system listed in the supported +[Operating Systems](#Operating-System) above and that Node.js is installed in the image. +It is recommended to have `unzip` installed. This avoids the Cypress binary installation falling back to a slower unzip method built in to Node.js. ## Next Steps From e063090dfc83ca88f325cedfc1d2404d0d5b8214 Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Tue, 2 Jul 2024 14:03:50 +0200 Subject: [PATCH 2/2] correct statement about unzip with Node.js --- docs/guides/getting-started/installing-cypress.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/getting-started/installing-cypress.mdx b/docs/guides/getting-started/installing-cypress.mdx index 9664984392..c9564564a3 100644 --- a/docs/guides/getting-started/installing-cypress.mdx +++ b/docs/guides/getting-started/installing-cypress.mdx @@ -248,7 +248,7 @@ allows you to generate your own customized Docker image easily. If you are not using a Cypress Docker image, make sure that your base operating system is a Linux system listed in the supported [Operating Systems](#Operating-System) above and that Node.js is installed in the image. -It is recommended to have `unzip` installed. This avoids the Cypress binary installation falling back to a slower unzip method built in to Node.js. +It is recommended to have `unzip` installed. This avoids the Cypress binary installation falling back to a slower unzip method using Node.js. ## Next Steps