Fruster File Service

Upload files to S3.

Subjects

file-service.get-signed-url

Returns signed url to a file in S3. The url is valid for 60 sec by default but can be configured by passing in expires in request data.

This is useful when bucket cannot be public on web.

Example

Get signed url for file /foo/bar.jpg that is valid for 2 minutes.

Request

{
    reqId: "0f21794e-ea9c-4ca3-a9e6-e0e962f14b45",
    data: {
        // doesn't mater if path starts with slash or not
        file: "foo/bar.jpg",

        // optional set for how long url is valid (default 1m)            
        expires: "2m"
    }
}

Response

{
    reqId: "0f21794e-ea9c-4ca3-a9e6-e0e962f14b45",
    data: {
        url: "https://fruster-uploads.s3.amazonaws.com/foo/bar?AWSAccessKeyId=AKIAI4TLHNQYQKYKPZFQ&Expires=1488042874&Signature=ua9M1rG145sN%2FZcrMRK4erswNUo%3D"
    }
}

REST API

Note that file service is slightly different compared to other Fruster services since it runs a web server and exposes an upload HTTP endpoint itself.

This is done simply because NATS is not good at handling large amount of data, such as large files.

POST /upload

Performs a multipart form upload.

Params

file - the file to send

Failure response

400 / 400.1 File not provided
400 / 400.2 File to large
403 / 403.1 Invalid file type
500 / 500.1 Unknown error

Configuration

# NATS servers, set multiple if using cluster
# Example: `['nats://10.23.45.1:4222', 'nats://10.23.41.8:4222']`
BUS = nats://localhost:4222

# HTTP port
PORT = 3001

# AWS S3 access key
AWS_ACCESS_KEY_ID = AKIAJPEXVPNKCC2H35AQ

# AWS S3 secret key
AWS_SECRET_ACCESS_KEY = "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"

# Name of S3 bucket
S3_BUCKET = "fruster-uploads"

# ACL for uploaded files, defaults to public-read which will make
# uploaded files public
S3_ACL="public-read"

# Max file size of uploaded files in mb 
MAX_FILE_SIZE_MB=5

# Cache control header set on uploaded files and on image responses    
CACHE_CONTROL_MAX_AGE=24h

FrostDigital / fruster-file-service