The Docker image discovers APIs in your GitHub account by scanning for OpenAPI or Swagger specifications in your repositories, as well as generating them using static code analysis.
It will create an API per repository, and potentially multiple collections for that API, in the FireTail SaaS Platform.
The docker image can be built by cloning the repository and using this docker command:
Run a test using the Dockerfile:
Run tests for the Golang analyser separately using the Dockerfile to yield a html coverage report:
Running the image requires two environment variables, `GITHUB_TOKEN` and `FIRETAIL_APP_TOKEN`. You can find a full list of environment variables used by the scanner below.
The scanner also requires a config file to determine the organisations, users and repositories to scan. You can find an example at You can find an example at config-example.yml.
Copy config-example.yml to config.yml and adjust it to your use case, then run the image using the following docker command: