> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chromiumly.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install Chromiumly and set up prerequisites for hosted or self-hosted use.

## Package install

<CodeGroup>
  ```bash npm theme={null}
  npm install chromiumly
  ```

  ```bash yarn theme={null}
  yarn add chromiumly
  ```

  ```bash bun theme={null}
  bun add chromiumly
  ```

  ```bash deno theme={null}
  deno add npm:chromiumly
  ```
</CodeGroup>

## 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](https://chromiumly.dev)

No Docker or local Gotenberg is required.

### Self-hosted Gotenberg

If you run Gotenberg yourself:

1. Install [Docker](https://www.docker.com/) if needed.
2. Start Gotenberg, for example:

```bash theme={null}
docker run --rm -p 3000:3000 gotenberg/gotenberg:8
```

3. Configure Chromiumly with the endpoint (see [Configuration](/configuration)).

## Optional config libraries

Chromiumly reads configuration from environment variables in all runtimes. On Node.js, you can optionally use [dotenv](https://www.npmjs.com/package/dotenv) or [config](https://www.npmjs.com/package/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](/configuration)).