Prerequisites
Prerequisites for installing Canyon on your own infrastructure.
Canyon is a JavaScript Code Coverage Data Collection Platform packaged as a set of Docker containers. You can install and run Canyon on any operating system that supports Docker Engine. Canyon can be used on your local machine or with your preferred cloud provider.
System Requirements
Canyon is designed to perform well in both small and large deployments. The minimum requirements for running Canyon are an operating system that supports Docker, 4 CPU cores + 4GB RAM to build images, and at least 1 CPU core + 2GB RAM to host the generated output files.
Install Node.js, npm, pnpm
Node.js + npm
Install Node.js (v18+) and npm (v9+).
pnpm
Install pnpm (v6+).
Docker
Install Docker (v20+).
Postgres Database
Canyon uses a Postgres database to store foundational data (requires version 14.x or higher). You can use any Postgres database provider you prefer—either hosted locally or through a cloud provider. Make sure you have a valid Postgres database URL in the following format:
postgresql://username:password@url:5432/dbnameCreate Tables
pnpm run migrate