Quick Start

Get your Pixelflare instance running in approximately 30 minutes using our automated setup.

Step 1: Fork the Repository

Fork the Pixelflare repository to your GitHub account:

Fork on GitHub

Step 2: Clone and Install

git clone https://github.com/YOUR-USERNAME/pixelflare.git
cd pixelflare
pnpm install

Step 3: Configure Environment

Copy the example environment file:

cp .env.example .env

Edit .env with your Cloudflare details:

See the Environment Variables guide for all options.

Step 4: Deploy Infrastructure

cd terraform
terraform init
terraform plan
terraform apply

Step 5: Configure Secrets

# Generate secrets
API_SECRET=$(openssl rand -hex 32)
UPLOAD_SECRET=$(openssl rand -hex 32)

# Set in Workers
echo $API_SECRET | wrangler secret put API_HASH_SECRET
echo $UPLOAD_SECRET | wrangler secret put UPLOAD_TOKEN_SECRET

Step 6: Deploy Application

pnpm deploy

Step 7: Verify

Visit your deployed instance:

• App: https://app.yourdomain.com
• API: https://api.yourdomain.com/health

Next Steps

• Configure Turnstile - Add bot protection
• Set up Analytics - Track usage
• Enable Custom Domains - User subdomains

Troubleshooting

Having issues? Check the Troubleshooting Guide.