Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/authress/document-library-microservice.js

This is a document library microservice which converts AWS S3 into a--Doc repository as a Service
https://github.com/authress/document-library-microservice.js

aws document-library document-repository dropbox google-drive library permissions repository s3 s3-bucket saas

Last synced: about 1 month ago
JSON representation

This is a document library microservice which converts AWS S3 into a--Doc repository as a Service

Awesome Lists containing this project

README 

        


  Authress media banner




# Authress example: AWS S3 Document Repository Microservice





    

    

    

    




This is the Document Library microservice.



It is an example that uses a REST api to expose S3 in a secure but abstracted way. The full details of the configuration are available in our [Knowledge Base](https://authress.io/knowledge-base/docs/implementation-examples/document-repository)



Specifically it uses S3 as a backend to expose a REST api providing the features of a Dropbox or Google Drive-like solution. To do this, it utilizes an [Authress account](https://authress.io) and deploys a Lambda microservice to CloudFront. It is a globally redundant service which is 100% serverless and scales with usage.



The Authress development team has provided this as a fully working service to demonstrate the ability to add granular access permissions to any microservice.



* _Sounds great, I want to deploy this already_ - [Deploy the S3 Document Library to my AWS account](https://us-east-1.console.aws.amazon.com/lambda/home?region=us-east-1#/create/app?applicationId=arn:aws:serverlessrepo:eu-west-1:922723803004:applications/S3-Document-Library)

* _What can this really do_ - [Features](#features)

* _I'm having a problem_ - [Troubleshooting](./docs/troubleshooting.md)

* _It would be really great if it also_ - [Create an issue](https://github.com/Authress/document-library-microservice.js/issues)

* _What does the API look like_ - [Service Routes](https://github.com/Authress/document-library-microservice.js/blob/release/0.1/src/index.js#L100) (We are working on exposing this in an API Explorer to make it easy to interact with.)



## Features

* Fully integratable with any user identity management tool. Follow the configuration steps and hook up the IdP to your Authress account.

* Utilizes CloudFront to be global accessible and redundant using Lambda@Edge for edge compute

* Generates Presigned urls where possible to enable GB or TB large uploads directly to and downloads from S3.

* Hierarchy based permissions management to give access to cascading resources.

* Multitenant architecture, enabling your users to use separated `accounts` to manage their own tenant in your service

* One-click deploys directly from the [AWS Serverless Application](https://us-east-1.console.aws.amazon.com/lambda/home?region=us-east-1#/create/app?applicationId=arn:aws:serverlessrepo:eu-west-1:922723803004:applications/S3-Document-Library)



## Setup

1. Deploy the lambda function using the `npm run deploy` function or directly from the [AWS Serverless Application](https://us-east-1.console.aws.amazon.com/lambda/home?region=us-east-1#/create/app?applicationId=arn:aws:serverlessrepo:eu-west-1:922723803004:applications/S3-Document-Library).

1. Configure your Authress account and generate a Service Client for access permission checks

1. Done!



## Troubleshooting

If you run into any problems just try running through the suggested [Troubleshooting steps](./docs/troubleshooting.md) and if that doesn't help, [file an issue](https://github.com/Authress/document-library-microservice.js/issues), we are usually quick to respond.