Deploying ssh_scan_api using docker compose

This page describes how to setup your own ssh_scan_api infrastructure...

1. Clone the ssh_scan_api repo

$ git clone https://github.com/mozilla/ssh_scan_api.git
$ cd ssh_scan_api

2. Stand up the environment with docker-compose

$ docker-compose up

3. Use examples/client.py API client in a different terminal to run a test scan

$ python examples/client.py

That's it! You're API should be listening on http://127.0.0.1:8000 now. You may want to throw Nginx or something in front of the API to provide TLS termination for a production install, but really that's up to you. An example of the nginx config we use in production can be found here