ipblock-microservice

A "cloud native" service in AWS that will check if an IP address exists in a Firehol blocklist. View the docs here.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

1. You will need an AWS account. You can create an AWS account and use the free tier.
2. You will need nodejs version 12 or higher.

Installing

1. Fork this repository on github
2. clone your copy to you local machine

   git clone git@github.com:<YOURUSERNAME>/ipblock-microservice.git

3. Move to your directory, open in vscode or your favorite editor and install the dependencies

   cd ipblock-microservice && code . && npm install

4. Install serverless globally; read the serverless documentation

   npm install -g serverless

5. Add your AWS credentials

   serverless config credentials --provider aws --key <YOUR KEY> --secret <YOUR SECRET>

Deployment

Deploying can be done with

serverless deploy

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Built With

• nodejs - framework
• serverless - npm package
• aws - deployment platform
• firehol blocklist-ipsets - filter list

Authors

• John Weland - initial work - johnweland.me

See also the list of contributors who participated in this project.

License

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