Skip to content

AI-native design editor. Open-source Figma alternative.

3.0 KB
Raw Blame

Deploying OpenPencil Cloud

OpenPencil Cloud runs as one Node 22+ process in front of PostgreSQL and an S3-compatible object store, with optional SMTP for email, or on Cloudflare Workers by copying cloudflare/. The project's own deployments live in openpencil/. See security.md for hardening checks.

Local development

From the repository root, with Docker running:

bun run cloud:dev
# OpenPencil Cloud: https://<branch>.cloud.open-pencil.localhost
# Captured email:  https://<branch>.mail.open-pencil.localhost

The command starts PostgreSQL, SeaweedFS, and Mailpit from compose.yml as a Compose project named after the branch, publishes them on free loopback ports, gives SeaweedFS and Mailpit HTTPS addresses through Portless, writes an ignored TOML file with the branch's Portless URLs under generated/, and runs the Cloud server on the host with bun --watch behind Portless. Browsers upload straight to object storage, and Safari blocks plain HTTP requests from an HTTPS page, so storage needs its HTTPS address too. Email and password sign-up is enabled, and every message lands in Mailpit.

bun run cloud:dev:down stops the services and removes the Mailpit and storage routes; their volumes are kept.

Self-hosting

Building, configuring, and running a server, the editor address, the first administrator, operator commands, email, storage, backups, and upgrades are covered in the self-hosting guide (packages/docs/reference/self-hosting-cloud.md). The example files it refers to are here: openpencil-cloud.example.toml and .env.example. Dockerfile builds the published image, ghcr.io/open-pencil/cloud, from the repository root, and compose.self-hosted.yml runs it on one machine with self-hosted/openpencil-cloud.toml.

End-to-end tests

bun --filter @open-pencil/cloud test:e2e         # PostgreSQL and SeaweedFS
bun --filter @open-pencil/cloud test:e2e:garage  # Garage S3 compatibility
bun --filter @open-pencil/cloud test:e2e:cloudflare  # the Worker under wrangler dev

The Cloudflare run needs dist-cloud/ (bun run build:cloud), which the Worker serves.

Each runner starts an isolated Compose project and removes it with its volumes afterwards. The main suite checks object-store readiness, a presigned single PUT and a 33 MiB three-part multipart upload (ordered ETags, metadata SHA-256, size, verified GET, deletion), then the full revision flow against real PostgreSQL: migrations, idempotent commits, stale-base conflicts, multipart cleanup, usage, and soft deletion.

The Garage profile (compose.garage.yml) pins Garage v2.3.0 as a single node. Configure Cloud for it with region = "garage", force_path_style = true, and checksum_verification = "metadata", and leave server-side encryption unset.