aws-s3-file-system

AWS S3 as File System Application - Spring Cloud AWS - Spring Boot - Thymeleaf

This is simple Spring Boot Application to upload/delete/search files in AWS S3 bucket. It uses Thymeleaf view tech and Bootstrap for responsive UI.

It also provides a REST api for creating Single Page Application using frameworks like Angular or React.

Tech

aws-s3-file-system uses a number of open source projects:

• Spring Boot - An opinionated framework for building production-ready Spring applications. It favors convention over configuration and is designed to get you up and running as quickly as possible.
• Spring Cloud AWS - Spring Cloud for Amazon Web Services, eases the integration with hosted Amazon Web Services. It offers a convenient way to interact with AWS provided services using well-known Spring idioms and APIs.
• Thymeleaf - Thymeleaf is a modern server-side Java template engine for both web and standalone environments.
• Bootswatch - A Boostrap theme for great UI boilerplate for modern web apps.

Installation and Configuration

$ git clone https://github.com/RawSanj/aws-s3-file-system.git

$ cd aws-s3-file-system

Configuration:

• Create a S3 bucket in Amazon Web Services.
• Create an IAM user with Programmatic access (i.e. enable access key ID and secret access key for the AWS API) and attach only AWS AmazonS3FullAccess policy.
• Add the above noted AWS Access key, Secret key and S3 Bucket name in /src/main/resources/application.properties file.

Run the application:

$ mvn clean package

$ mvn spring-boot:run

Run in Docker

Build and run locally in Docker:

Build the WAR file:

$ mvn clean package

Build docker image:

$ mvn docker:build

Run docker image by passing credentials in Environment variables:

$ docker run -d -p 8080:8080 \
$ -e cloud.aws.credentials.accessKey=ACCESS_KEY \
$ -e cloud.aws.credentials.secretKey=SECRET_KEY \
$ -e cloud.aws.region.static=REGION \
$ -e aws.bucket.name=BUCKET_NAME \
$ rawsanj/aws-s3-file-system

Or Run docker image by updating the env.list file with AWS Credentials:

$ docker run -d -p 8080:8080 --env-file env.list rawsanj/aws-s3-file-system

Run on Cloud:

Try http://play-with-docker.com for running docker on browser without any local setup.

Run the docker image available in Docker Hub:

$ docker run -d -p 8080:8080 \
$ -e cloud.aws.credentials.accessKey=ACCESS_KEY \
$ -e cloud.aws.credentials.secretKey=SECRET_KEY \
$ -e cloud.aws.region.static=REGION \
$ -e aws.bucket.name=BUCKET_NAME \
$ rawsanj/aws-s3-file-system

Tools

The following tools are used to create this project :

• Spring Tool Suite
• Maven
• Google Chrome
• Git

License

Apache License 2.0

Copyright (c) 2017 Sanjay Rawat