Image processing service based on Sharp and Micro.
$ yarn install
$ yarn run start
We recommend to use Now together with Now CDN. See Now CDN documentation for setup.
To deploy this, run the following command.
$ now barnebys/bimp
Enter a SECRET (or a WHITELIST domain prefix) and a DEFAULT_IMAGE_URL. Leave the env empty to disable signed url's and/or a no image url.
To enable S3 pass along the following env's S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_BUCKET, S3_PREFIX
To specify the env upon deployment add the -e flag
$ now barnebys/bimp -e SECRET=MySecret -e DEFAULT_IMAGE_URL=https://someurl.com/image.jpg
note: to set empty env's pass the env's with empty string e.g. -e SECRET=""
https://<your-fqdn>/<url-or-path>?w=<width>&h=<height>&crop=<mode>
| Parameter | Function |
|---|---|
w |
Image width |
h |
Image height |
crop |
Cropping mode |
extract |
Extract a region of the image |
trim |
Trim "boring" pixels from all edges |
pad |
Add padding |
bg |
Add a color to replace alpha or padded area |
format |
Set output format |
s |
Signed hash |
Resize image to width x height. When both height and width are use the image will be cropped to the specified size using center as default.
Crop the resized image to the exact specified size. Default is center.
Possible attributes are north, northeast, east, southeast, south,
southwest, west, northwest, center, centre, entropy and attention.
Other strategies for corpping are:
entropy: focus on the region with the highest Shannon entropy.
attention: focus on the region with the highest luminance frequency, colour saturation and presenece of skin tones..
Extract a region of the image using using left, top, width and height. Set left and top as offset and width and height for dimensions to extract.
extract=<left>,<top>,<width>,<height>
extract=0,0,500,200
Trim "boring" pixels from all edges using a tolerance (maximum of 99).
trim=10
Add padding to the image
pad=50
Replace alpha channel, or padded area, with a color.
bg=ffffff
Currently only supports compresswhich enables a higher compression.
format=compress
- More sharp features
- More providers