Skip to main content

Quick Start

We'll go over installation, basic configuration, and deployment

Prerequisites​

  • AWS Account
  • Serverless
  • NodeJs 18.x

Once you have installed Serverless for your environment, follow this guide to connect your Serverless installation to your AWS account:

Serverless.com: AWS Lambda Guide - Credentials

Installation​

Step 1: Clone​

Clone the latest version of the project into a directory of your choice:

git clone -b 'v3.0.0' --single-branch --depth 1 https://github.com/venveo/serverless-sharp.git

Always check the releases page to make sure you're cloning the latest version.

Step 2: Configure​

Enter the directory you cloned the project into and copy the settings.example.yml file to settings.mysite.yml

Open the file and make the appropriate configuration changes. At the very minimum, configure the SOURCE_BUCKET property to your S3 bucket where the source images live. For example: images.mysite.com

Step 3: Deploy​

serverless deploy --settings settings.mysite.yml