Agent Docker image¶

Usage¶

The image is already published in our dockehub page, so you just have to pull our image with the following command

$ docker pull faradaysec/faraday_agent_dispatcher

After that you only need a .yaml file to pass to the image. We already have some templates to use. For these you have to edit it in the first lines:

server:
  api_port: '5985' # TODO be replaced with network configuration
  host: localhost
  ssl: 'False'
  ssl_cert: ''
  websocket_port: '9000'

After setting the values in the .yaml file, you can run the agent as:

$ docker run -v {ABSOLUTE_PATH_TO_YAML}:/root/.faraday/config/dispatcher.yaml faradaysec/faraday_agent_dispatcher --token={TOKEN}

Migrating from .ini

If you had an old version from agent-dispatcher, you can migrate your dispatcher.ini file as follows:

docker run -v {ABSOLUTE_PATH_TO_INI}:/root/.faraday/config/dispatcher.ini -v {ABSOLUTE_PATH_TO_YAML}:/root/.faraday/config/dispatcher.yaml --entrypoint "/usr/local/bin/faraday-dispatcher" faradaysec/faraday_agent_dispatcher config-wizard

Warning

As we explain in the getting started guide, you only need the token the first time you run an agent

Templates¶

We currently have 2 templates:

Base Agent

This template use is as simple as shown above

$ docker run -v {ABSOLUTE_PATH_TO_INI}:/root/.faraday/config/dispatcher.ini -it faradaysec/faraday_agent_dispatcher --token={TOKEN}

old .ini version

This template is the old .ini version of this template, it actually don't work with version 2.0.0

With reports

This template adds the possibility of use a path to read reports from the host machine.

$ docker run -v {ABSOLUTE_PATH_TO_INI}:/root/.faraday/config/dispatcher.ini  -v {ABSOLUTE_PATH_TO_REPORT_FOLDER}:/root/reports/ -it faradaysec/faraday_agent_dispatcher --token={TOKEN}

Then you can process any report by just specifying the route to the report file as an executor parameter

old .ini version

This template is the old .ini version of this template, it actually don't work with version 2.0.0