🖼️ IPX

High performance, secure and easy to use image proxy based on sharp and libvips.

Usage

Quick Start

You can use ipx command to start server using:

$ npx ipx

The default server directory is the current working directory.

Programatic Usage

You can use IPX as a Connect/Express middleware or directly use ipx api.

import { createIPX, createIPXMiddleware } from "ipx";

const ipx = createIPX(/* options */);
const app = express();
app.use("/image", createIPXMiddleware(ipx));

Examples

Get original image:

/_/static/buffalo.png

Change format to webp and keep other things same as source:

/f_webp/static/buffalo.png

Keep original format (png) and set width to 200:

/w_200/static/buffalo.png

Resize to 200x200px using embed method and change format to webp:

/embed,f_webp,s_200x200/static/buffalo.png

Modifiers

Config

Config can be customized using IPX_* environment variables.

• IPX_DIR

  • Default: . (current working directory)

• IPX_DOMAINS

  • Default: []

• IPX_MAX_AGE

  • Default: 300

• IPX_ALIAS

  • Default: {}

• IPX_FETCH_OPTIONS

  • Default: {}

License

MIT