summaryrefslogtreecommitdiffstats
path: root/cypress-docker/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cypress-docker/README.md')
-rw-r--r--cypress-docker/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/cypress-docker/README.md b/cypress-docker/README.md
new file mode 100644
index 0000000..2e8c532
--- /dev/null
+++ b/cypress-docker/README.md
@@ -0,0 +1,38 @@
+# Cypress Docker Images
+
+./node_modules/.bin/stop-only cypress
+
+These images provide all of the required dependencies for running Cypress in Docker.
+
+We have two main images:
+
+| Image | Default | CI Build | Description |
+| ---------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
+| [cypress/base](base) | `cypress/base:8` | [![Docker Build Status](https://img.shields.io/docker/build/cypress/base.svg)](https://hub.docker.com/r/cypress/base/) | All system dependencies, no browsers. |
+| [cypress/browsers](browsers) | `cypress/browsers` | [![Docker Build Status](https://img.shields.io/docker/build/cypress/browsers.svg)](https://hub.docker.com/r/cypress/browsers/) | All system dependencies and Chrome and Firefox browsers. |
+
+Of these images, we provide multiple tags for various operating systems and specific browser versions. These allow you to target specific combinations you need. We only provide browsers for `Debian`, but you can use our base images and build your own.
+
+| Name + Tag | Node | Operating System | Dependences | Browsers |
+| -------------------------------------------------------- | ---- | ---------------- | ----------- | ---------------- |
+| [cypress/base:4](base/4) | 4 | Debian | ✅ | 🚫 |
+| [cypress/base:6](base/6) | 6 | Debian | ✅ | 🚫 |
+| [cypress/base:8](base/8) | 8 | Debian | ✅ | 🚫 |
+| [cypress/base:10](base/10) | 10 | Debian | ✅ | 🚫 |
+| [cypress/base:centos7](base/centos7) | 6 | CentOS | ✅ | 🚫 |
+| [cypress/base:ubuntu16](base/ubuntu16) | 6 | Ubuntu | ✅ | 🚫 |
+| [cypress/browsers:chrome65-ff57](browsers/chrome65-ff57) | 8 | Debian | ✅ | Chrome 65, FF 57 |
+
+## DockerHub
+
+All of the images and tags are [published to DockerHub here](https://hub.docker.com/r/cypress).
+
+## Examples
+
+We utilize many of these docker images in our own projects, with different CI providers.
+
+[Check out our docs for examples.](https://on.cypress.io/docker)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)