Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 1.32 KB

README.md

File metadata and controls

66 lines (41 loc) · 1.32 KB
Raw

Screenshotgun server

Use this application as a backend for Screenshotgun.

Build and run

npm i
npm run build
npm run start

The app requires environment variables to be set at runtime.

Docker

Image at Docker Hub

Pull

docker pull ismd/screenshotgun-api

Run

docker run -p 80:80 \
  -e WEBSITE=<url> \
  -e S3_ENDPOINT=<s3_endpoint> \
  -e S3_BUCKET=<s3_bucket> \
  -e AWS_ACCESS_KEY_ID=<aws_access_key> \
  -e AWS_SECRET_ACCESS_KEY=<aws_secret_access_key> \
  ismd/screenshotgun-api

See below about environment variables.

Environment variables

To launch the server you shoud set these variables:

  • PORT optional

Port on which to run server. Default 80.

  • UPLOAD_DESTINATION

The only available value is aws.

  • WEBSITE

This url will be used for link generation. The website should be available on this url.

  • S3_ENDPOINT

Defines S3 endpoint.

  • S3_BUCKET

Defines S3 bucket.

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY

Read more about AWS keys