genzerhawker/docs3 repository overview

⁠docs3 - Docs on S3

This repository aims to serve static files stored in AWS S3 Bucket through a very simple HTTP API.

The reason for this module is that I want to host some static websites (mainly documentations) but I don't want to use make my Bucket publicly read from the Internet.

⁠Prerequisites

• AWS Credentials. Or if you are running using the EC2 IAM Role which has been granted to access to S3.
• Node.js v10

⁠Getting Started

1 - Install all packages.

npm install

2 - Serve

AWS_BUCKET_NAME=your-bucket-name node app.js