Skip to content

Commit d65d514

Browse files
authored
docs: updating installation guide with hardware reqs (cypress-io#4586)
1 parent 8c22d2f commit d65d514

File tree

2 files changed

+41
-9
lines changed

2 files changed

+41
-9
lines changed

content/guides/continuous-integration/introduction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,9 @@ maintained images and configurations on several CI providers.
243243

244244
Hardware requirements to run Cypress depend how much memory the browser, the
245245
application under test, and the server (if running it locally) need to run the
246-
tests without crashing.
246+
tests without crashing. Visit our
247+
[System Requirements](/guides/getting-started/installing-cypress#System-requirements)
248+
guide for minimum hardware recommendations.
247249

248250
**Some signs that your machine may not have enough CPU or memory to run
249251
Cypress:**

content/guides/getting-started/installing-cypress.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,25 +132,57 @@ everything you need prebuilt.
132132

133133
## System requirements
134134

135-
<Alert type="info">
136-
137-
#### Operating System
135+
### Operating System
138136

139137
Cypress is a desktop application that is installed on your computer. The desktop
140138
application supports these operating systems:
141139

142140
- **macOS** 10.9 and above _(Intel or Apple Silicon 64-bit (x64 or arm64))_
143141
- **Linux** Ubuntu 12.04 and above, Fedora 21 and Debian 8 _(x86_64 or Arm
144-
64-bit (x64 or arm64))_
142+
64-bit (x64 or arm64))_ (see [Linux Prerequisites](#Linux-Prerequisites) down
143+
below)
145144
- **Windows** 7 and above _(64-bit only)_
146145

147-
#### Node.js
146+
### Node.js
148147

149148
If you're using `npm` to install Cypress, we support:
150149

151150
- **Node.js** 12 or 14 and above
152151

153-
#### Linux
152+
### Hardware
153+
154+
When running Cypress locally, it should run comfortably on any machine that is
155+
capable of modern web development.
156+
157+
When running Cypress in CI, however, some of the lower-tier configurations might
158+
not be able to run Cypress reliably, especially when recording videos or doing
159+
longer test runs.
160+
161+
Some issues you might run into in CI that could be a sign of insufficient
162+
resources are:
163+
164+
- Exiting early during `cypress run` or abruptly closing (“crashing”)
165+
- Frozen or missing frames in the video that is captured
166+
- Increased runtime
167+
168+
When running Cypress in CI, we recommend that you have the following hardware
169+
requirements:
170+
171+
#### CPU
172+
173+
- 2 CPUs minimum to run Cypress
174+
- 1 additional CPU if video recording is enabled
175+
- 1 additional CPU per process you run outside of Cypress, such as:
176+
- App server (frontend)
177+
- App server (backend)
178+
- App database
179+
- Any additional infrastructure (Redis, Kafka, etc..)
180+
181+
### Memory
182+
183+
- 4GB minimum, 8GB+ for longer test runs
184+
185+
### Linux Prerequisites
154186

155187
If you're using Linux, you'll want to have the required dependencies installed
156188
on your system.
@@ -187,8 +219,6 @@ container with the Node.js process.
187219

188220
**Great, now [install Cypress](#Installing)!**
189221

190-
</Alert>
191-
192222
## Next Steps
193223

194224
[Open the app](/guides/getting-started/opening-the-app) and take it for a test

0 commit comments

Comments
 (0)