/url-to-png

Selfhosted. URL to PNG utility featuring parallel rendering using Playwright for screenshots and with storage caching via Local, S3, or CouchDB

Primary LanguageTypeScriptMIT LicenseMIT

URL to PNG logo
URL to PNG

GitHub License GitHub Workflow Status Docker Pulls

A URL to PNG generator over HTTP with a fairly simple API accessed via query params passed to the server.

  • Generate PNG images from URLs
  • Customizable image dimensions and viewport size
  • Support for mobile user agent and dark mode rendering
  • Caching of generated images
  • Allow list for domain-specific requests
  • Configurable Playwright options
  • Integration with various storage providers (AWS S3, CouchDB, Filesystem)
  • Prometheus metrics endpoint

Getting Started

Checkout the docs to getting_started

Docker

Run the following command:

docker run --rm -p 3089:3089 ghcr.io/jasonraimondi/url-to-png

On the hub: Link to DockerHub

Local Serve

Serve the project

git clone https://github.com/jasonraimondi/url-to-png
cd url-to-png
pnpm install
pnpm exec playwright install chromium
pnpm dev

Configuration

Read the full config options

Encryption

Learn about encryption

Metrics

Learn about metrics

Star History

Star History Chart