ipx

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

The examples assume that a static folder with buffalo.png file is present in the directory where IPX server is running.

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

http://localhost:3000/static/buffalo.png?format=webp

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

http://localhost:3000/static/buffalo.png?width=200

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

http://localhost:3000/static/buffalo.png?embed&format=webp&resize=200

Modifiers

Property	Reference	Example	Comments
width	_	http://localhost:3000/buffalo.png?width=200
height	_	http://localhost:3000/buffalo.png?height=200
trim	Ref	http://localhost:3000/buffalo.png?trim=100
format	Ref	http://localhost:3000/buffalo.png?format=webp	Supported format: jpg, jpeg, png, webp, avif, gif, heif
quality	_	http://localhost:3000/buffalo.png?quality=50	Accepted values: 0 to 100
rotate	Ref	http://localhost:3000/buffalo.png?rotate=45
flip	Ref	http://localhost:3000/buffalo.png?flip
flop	Ref	http://localhost:3000/buffalo.png?flop
sharpen	Ref	http://localhost:3000/buffalo.png?sharpen=30
median	Ref	http://localhost:3000/buffalo.png?median=10
gamma	Ref	http://localhost:3000/buffalo.png?gamma=3
negate	Ref	http://localhost:3000/buffalo.png?negate
normalize	Ref	http://localhost:3000/buffalo.png?normalize
threshold	Ref	http://localhost:3000/buffalo.png?threshold=10
tint	Ref	http://localhost:3000/buffalo.png?tint=1098123
grayscale	Ref	http://localhost:3000/buffalo.png?grayscale
animated	-	http://localhost:3000/buffalo.gif?animated	Experimental

Config

Config can be customized using IPX_* environment variables.

• IPX_DIR

  • Default: . (current working directory)

• IPX_DOMAINS

  • Default: []

License

MIT