Deploying ssh_scan_api using docker compose

This page describes how to setup your own ssh_scan_api infrastructure using the docker deployment strategy.

Requirements

• docker (latest version)
• docker-compose (latest version)
• 64bit OS (Mac/Linux)
• python, pip, and python requests module (this for the python client example to work)

Clone the git repo

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

Stand up the environment

$ sudo docker-compose up

Run a test scan

$ python examples/client.py

That's it! Your API should be listening on http://127.0.0.1:8000 now. You may choose to throw NGINX or another HTTP server 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 configuration we use in production can be found here