Installation and Build

Learn how to install and build Canyon Community Edition.

Configure Environment

Before starting installation, you need to configure environment variables.


# Prisma Config
DATABASE_URL=postgres://username:password@localhost:5432/dbname

Clone the project


git clone https://github.com/canyon-project/canyon

Install dependencies and build the project


pnpm install && pnpm run build

Modify .env file and create database tables


pnpm run migrate

Run the project using Node.js


node packages/canyon-backend/dist/main.js

To run Canyon using Docker, just specify the environment variable file path and port number


docker run -d -p 8080:8080 -v /your/path/.env:/app/.env zhangtao25/canyon:main

After successful startup, there will be two main services:

Visit http://localhost:8000/login to log in to Canyon.