Skip to main content

​
Package install

npm install chromiumly

​
Prerequisites

​
Hosted API

For the hosted API at https://api.chromiumly.dev, required:
  • A supported runtime: Node.js 18+, Deno 1.x, or Bun
  • An API key from chromiumly.dev
No Docker or local Gotenberg is required.

​
Self-hosted Gotenberg

If you run Gotenberg yourself:
  1. Install Docker if needed.
  2. Start Gotenberg, for example:
docker run --rm -p 3000:3000 gotenberg/gotenberg:8
  1. Configure Chromiumly with the endpoint (see Configuration).

​
Optional config libraries

Chromiumly reads configuration from environment variables in all runtimes. On Node.js, you can optionally use dotenv or config to load the same env vars or config keys:
  • dotenv — load .env into process.env
  • config — read from config/default.json (e.g. gotenberg.endpoint)
Configure in code via Chromiumly.configure() (see Configuration).