Skip to Content
DocumentationSelf HostCommunity EditionPrerequisites

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 machine or on your chosen cloud provider.

System Requirements

Canyon is designed to run well in both small and large deployments. The minimum requirements to run Canyon are an operating system that supports Docker 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

Install Node.js (v18+) and npm (v9+).

Install pnpm (v9 recommended).

Install Docker (v20+).

PostgreSQL Database

Canyon uses a PostgreSQL database to store basic data (requires 14.x or above). You can use any PostgreSQL database provider of your choice - hosted locally or on a cloud provider. Make sure you have a valid PostgreSQL database URL in the following format:

Create Tables

Or directly use the table creation SQL.