Documentation

Getting Started

Pixelflare is designed to be deployed on Cloudflare's infrastructure. You'll need a Cloudflare account to get started.

Quick Start

  1. Fork the repository
  2. Configure GitHub secrets
  3. Run the deployment workflow
  4. Access your CDN!

Installation

Detailed installation instructions:

1. Prerequisites

  • Cloudflare account
  • GitHub account
  • Node.js 20+ and pnpm

2. Configuration

Set the following secrets in your GitHub repository:

CLOUDFLARE_API_TOKEN=your_cloudflare_api_token
CLOUDFLARE_ACCOUNT_ID=your_account_id
API_HASH_SECRET=random_secret_key

API Reference

Pixelflare provides a RESTful API for programmatic access.

POST /v1/images - Create Image

Create a new image and get an upload URL.

{
  "filename": "beach.jpg",
  "album": "summer-2025",
  "tags": ["vacation", "beach"]
}
GET /v1/images - List Images

List all images with optional filtering.

Query parameters: limit, cursor, album, tag

GET /v1/images/:id - Get Image

Retrieve metadata for a specific image.

Image Variants

Pixelflare automatically generates image variants for optimal delivery:

Width Variants

  • w128 - Max width 128px
  • w256 - Max width 256px
  • w512 - Max width 512px
  • w1024 - Max width 1024px
  • w1536 - Max width 1536px
  • w2048 - Max width 2048px

Special Variants

  • original - Original image (no transformation)
  • thumb - Square thumbnail 128×128
  • og-image - Social media card 1200×630

FAQ

Is Pixelflare really free?

Yes! Pixelflare runs on Cloudflare's generous free tier. You only pay if you exceed the free limits, which are quite high for most use cases.

Can I use my own domain?

Absolutely! Configure your domain in Cloudflare and update the environment variables.

What image formats are supported?

JPEG, PNG, WebP, AVIF, GIF, SVG, and HEIC are all supported.