git-lfs-lambda-server

This is an AWS Lambda implementation of the git-lfs specification

Running locally

The server package is not meant to be used in a production capacity on its own, but it is doable.

Prerequisites

You will need both NodeJS and Docker installed. You will also need to have your AWS credentials set up locally as you would with the AWS CLI.

Installing

Either clone this repository or install via NPM with:

npm install git-lfs-lambda-server

In the project there is a test service template as well as a runLocal script. The script and template both use a currently hardcoded name of 'cloudrepo' for the target repo it is intended to emulate. If you wan to actually use this server package locally, you will need to replace occurrences of 'cloudrepo' with your desired naming. You will also need to manually create the required S3 bucket.

Executing runLocal will launch the service functions in local docker containers via the AWS SAM Local tool. The functions will then be available as localhost URIs.

At this point, you can configure your git lfs repo to use the local endpoints with something like:

git config lfs.url https://127.0.0.1:3000/cloudrepo.git/info/lfs

Your git repo will now talk to your local Docker API to receive upload/download instructions to store your binary files in the specified S3 bucket.

Built With

• git-lfs
• NodeJS
• Docker
• AWS SAM - AWS Serverless Template setup
• AWS SAM Local - local SAM environment

Contributing

Go for it, man.

Versioning

I use SemVer for versioning. For the versions available, see the releases page.

Authors

• Ken George - Project creator
• Other Contributors

License

This project is licensed under the MIT License - see the LICENSE file for details