Socket
Socket
Sign inDemoInstall

@resourcefulhumans/rheactor-image-service

Package Overview
Dependencies
68
Maintainers
3
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @resourcefulhumans/rheactor-image-service

An image processing backend running on AWS Lambda.


Version published
Weekly downloads
1
Maintainers
3
Created
Weekly downloads
 

Readme

Source

rheactor-image-service

npm version Build Status monitored by greenkeeper.io js-standard-style semantic-release Test Coverage Code Climate

An image processing backend running on AWS Lambda.

Uses gm with GraphicsMagick (which is available by default) on AWS lambda.

It takes JPEG or PNG images that are uploaded base64 encoded, resizes them on the fly to 256x256px size, and stores them on an S3 bucket.

Request

Users need to provide an JsonWebToken which is checked against the configured public key.

POST /upload
Content-Type: application/vnd.resourceful-humans.rheactor-image-service.v1+json
Authorization: Bearer <token>

{
  "$context":"https://github.com/ResourcefulHumans/rheactor-image-service#Upload",
  "image":"R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7",
  "mimeType":"image/png"
}

Response

Content-Type: application/vnd.resourceful-humans.rheactor-image-service.v1+json

{
  "$context":"https://github.com/ResourcefulHumans/rheactor-image-service#UploadResult",
  "url":"https://s3.eu-central-1.amazonaws.com/rheactor-image-service/example.com/33f24f55-e435-4198-a148-fdd1095ffa96-user-5.jpg",
  "mimeType":"image/jpeg"
}

This implementation expects token's sub to be an URL, which will be used to prefix and suffix URLs. A sub value of https://example.com/user/5 was used in the example above.

Configuration

These environment variables need to be set on the lambda function:

  • S3_BUCKET
    Name of the S3 bucket, e.g. rheactor-image-service to where files are uploaded.
  • S3_REGION
    Region to use.
  • MOUNT_URL
    Public endpoint for the lamba function (as provided by API Gateway)
  • WEB_LOCATION
    Public URL for the bucket
  • PUBLIC_KEY
    Public key to be used for verifying tokens

Setup

npm install

# Configure these environment variables
AWS_ROLE=…
AWS_ACCESS_KEY_ID=…
AWS_SECRET_ACCESS_KEY=…
AWS_REGION=…
AWS_FUNCTION_NAME=…
NODE_ENV=…
VERSION=…

# install this as a new lambda function
make install

Keywords

FAQs

Last updated on 24 Feb 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc