Prerequisites
Prerequisites for installing Canyon on your own infrastructure.
Canyon is a self-hosted API development platform packaged as a set of Docker containers. You can install and run Canyon on any operating system that can run Docker Engine . You can use Canyon on your local computer or on a cloud provider of your choice.
System Requirements
Canyon is designed to run well in both small and large deployments. The minimum requirements to run Canyon are a Docker-supported operating system and 4 CPU cores + 4GB RAM to generate 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 (v9 recommended).
Docker
Install Docker (v20+).
Postgres Database
Canyon uses a Postgres database to store base data (requires 14.x or higher). You can use any Postgres database provider of your choice - hosted locally or on a cloud provider. Make sure you have a valid Postgres database URL in the following format:
postgres://username:password@localhost:5432/dbnameCreate Tables
pnpm run migrateOr directly use the table creation SQL .