Super fast, on-demand and on-the-fly, image processing.
Cometa uses sharp for image manipulation.
- Clone this repository (navigate to its location),
- copy the
.env.exampleto.envand fill the required values, - install what is needed:
npm i, - test:
npm test, - run:
npm start
Cometa should now be running on the specified port.
COMETA_CLUSTER: Whether the application should make use of all available CPUs or not.COMETA_PORT: Port on which your application will listen.Defaults to 9090.COMETA_KEY: A unique key used for request signature validation.COMETA_ALLOW_UNAUTHORIZED: Whether unsigned requests are allowed or not.COMETA_REQUEST_TIMEOUT: (milliseconds) before timing out URL image requests.COMETA_LOG_NAME: The name for your logs (if enabled).Defaults to 'Cometa'.COMETA_LOG_LEVEL: The minimal level at which to log. See pino's log levelsDefaults to 'info'
AWS_ACCESS_KEY: Your AWS access key.AWS_ACCESS_SECRET: Your AWS access secret.AWS_BUCKET: The name of your S3 bucket.AWS_REGION: Your AWS service region.
If, for example, in your AWS_BUCKET bucket, you have a folder named cometa with an image called superlight.jpg, your request will be:
GET /s3/cometa/superlight.jpg
Just provide the URL of the image you are requesting:
GET /url/http://images.google.com/cars.jpg
w||width: (integer) Output width,h||height: (integer) Output height,q||quality: (integer) Output image quality. Defaults to80, ignored onpngoutput.
Supported input formats are: webp, png, tiff and jpeg (aka jpg).
Supported output formats are: webp, png, tiff, and jpeg (aka jpg).
Simply append the required output format to URL:
GET /s3/cometa/superlight.jpg.webp
GET /url/http://images.google.com/cars.jpg.webp
// Outputs webp
GET /s3/cometa/superlight.jpg.png
GET /url/url=http://images.google.com/cars.jpg.png
// Outputs png
Take, for example:
GET /s3/cometa/superlight.jpg?width=200&height=200
Malicious users could easily overload your server by making thousands of consecutive requests with varying widths and heights.
Luckily, Cometa provides a way of authenticating the request -and we strongly recommend you use it.
Authenticate your request by computing a SHA-1 hmac signature, with your COMETA_KEY and pass it to the request.
const url = '/s3/cometa/superlight.jpg?width=200&height=200';
const signature = crypto
.createHmac('sha1', COMETA_KEY)
.update(url)
.digest('hex');You may pass the signature as a query parameter:
GET /s3/cometa/superlight.jpg?width=200&height=200&authorization=[signature]
or as a HTTP header:
headers {
'Authorization': [signature]
}Note: Allowing unsigned requests can be dangerous. Use at your own discretion
fork https://github.com/CometaFront/Cometa/
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent