Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms


faraday (11) Versions 1.1.0

Installs/Configures Faraday

cookbook 'faraday', '= 1.1.0'
cookbook 'faraday', '= 1.1.0', :supermarket
knife supermarket install faraday
knife supermarket download faraday
Quality -%

faraday Cookbook

Installs and configures Faraday - A collaborative penetration testing tool!

Cookbook Version Build Status




  • couchdb


The following platforms and versions are tested and supported using Opscode's test-kitchen. - Debian 7 - Debian 8



Key Type Description
[faraday][packages] Array Package list to install (default: [git-core, libpq-dev])
[faraday][gtk_packages] Array Python packages to install (default: [gir1.2-gtk-3.0 gir1.2-vte-2.91 python-pip python-gobject zsh curl])
[faraday][git_repository] String Faraday repository (default:
[faraday][git_reference] String Faraday reference or version (default: v1.0.21)
[faraday][install_dir] String Faraday install directory (default: /opt/faraday)
[faraday][python_runtime] String Python runtime to use, used for poise-python cookbook (default: 2)
[faraday][user] String User to configure, must exists (default: root)
[faraday][home] String User's home directory (default: /root)
[faraday][config] Hash Hash of faraday configuration (See attributes file for defaults)
[faraday][config_attrs] Hash XML attributes for faraday configuration (See attributes file for defaults)
[faraday][cscan][pip_packages] Array Python packages to install (default: [python-owasp-zap-v2 w3af-api-client])
[faraday][cscan][config] Hash Configuration for default cscan (default: node[faraday][config])
[faraday][cscan][ips] Array List of IPs for default cscan (default: [])
[faraday][cscan][websites] Array List of websites for default cscan (default: [])
[faraday][service] Hash Hash of variables to override for service init script

All others attributes in ['faraday']['config'] namespace will generate dynamically the configuration file as XML format in $HOME/.faraday/config/config.xml.

Use the ['faraday']['config_attrs'] namespace to set xml attributes. See [default attributes](attributes/default.rb) for more details.



You have two ways to install Faraday:


Use faraday::package to only install python-faraday package:

  "run_list": [


Include faraday::sources in your node's run_list to install faraday and its requirements from source:

  "run_list": [
  "attributes": {
    "faraday": {
      "git_reference": "v1.0.20",
      "install_dir": "/opt/faraday-1.0.20"

The faraday::default recipe will only install package dependencies. It is included in faraday::package and faraday::sources.


If you want to use the GTK GUI, you can include faraday::gtk to install extra dependencies.

  "run_list": [



Include faraday::config in your node's run_list to configure faraday for a user:

  "run_list": [
  "attributes": {
    "faraday": {
      "user": "my_user",
      "config": {
        "couch_uri": "",
        "last_workspace": "my_workspace"


Include faraday::cscan in your node's run_list to configure default continuous scanning:

  "run_list": [
  "attributes": {
    "faraday": {
      "cscan": {
        "config": {
          "couch_uri": "https://couchdb-host:6984",
          "last_workspace": "cscan_workspace"
        "ips": [""],
        "websites": [""]


Include faraday::service in your node's run_list to configure faraday as a server (Experimental):

  "run_list": [
  "attributes": {
    "faraday": {
      "git_reference": "v1.0.20",
      "install_dir": "/opt/faraday",
      "python_runtime": "2",
      "service": {
        "RUN": "true",
        "NAME": "faraday-server",
        "USER": "faraday",
        "INSTALL_DIR": "/opt/faraday",
        "DAEMON_ARGS": " --gui=no-gui --port 31337"
      "config": {
        "version": "1.0.20",
        "couch_uri": ""

Custom resources


This LWRP can be used to deploy many faraday configuration.

Action Description
:create Create configuration for a specific user
:delete Delete user's configuration file
Attribute Type Description
owner String Owner config file, this is the name attribute of this resource
home String Home directory, if nil: provider will determine it depending of owner (default: nil)
file String Configuration file name (default: config.xml)
cookbook String Optional cookbook name for template resource (default: faraday)
config Hash Configuration to deploy (default: {})
config_attrs Hash Config attributes (default: {})
faraday_config 'sliim' do
  config last_workspace: 'sliim-corp'

faraday_config 'sliim' do
  action :delete
  file 'user.xml'


Install and configure a continuous scanning directory.

Action Description
:install Install a new continuous scanning directory
:configure Configure a continuous scanning install
Attribute Type Description
name String Continuous scanning name (final dirname will be prepended with cscan-)
path String Optional path where will be created cscan dir (default: FARADAY_INSTALL_DIR/scripts)
git_repository String cscan repository (default:
git_reference String cscan reference (default: master)
ips Array List of IPs to configure (default: [])
websites Array List of websites to configure (default: [])
config Hash Config attributes (default: node[faraday][cscan][config])
cookbook String Optional cookbook name for templates (default: faraday)
crond Hash Cron setup. These attributes will be used for cron_d resource (default: {})
faraday_cscan 'local' do
  action [:install, :configure]
  ips ['',
  crond hour: 13,
        minute: 37,
        weekday: 5,
        user: 'faraday',
        mailto: '',
        command: ./ -p >> cron.log 2>&1 && mv output/* /opt/faraday/.faraday/report/cscan-local



  • First, install dependencies:
    bundle install

  • Run Checkstyle and ChefSpec:
    bundle exec rake

  • Run Kitchen tests: bundle exec rake kitchen

If you have Docker, you can use the kitchen driver which is faster: export
bundle exec rake kitchen


  1. Fork the repository on Github
  2. Create a named feature branch (like add_component_x)
  3. Write your change
  4. Write tests for your change (if applicable)
  5. Run the tests, ensuring they all pass
  6. Submit a Pull Request using Github

License and Authors

Authors: Sliim

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Dependent cookbooks

cron >= 0.0.0
poise-python >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.


This file is used to list changes made in each version of the faraday cookbook.


  • Provides multiple ways to install Faraday
  • Add recipe to install GTK dependencies
  • Set default Faraday version to 1.0.21
  • New recipes: faraday::gtk, faraday::package and faraday::sources


  • Default faraday version: 1.0.20


  • Continuous scanning cronjob fix


  • Default faraday version: 1.0.16


  • New recipe faraday::service
  • New LWRP: faraday_config to manage faraday configs
  • New LWRP: faraday_cscan to manage cscan dirs
  • New dependencies: poise-python (replace python) and cron
Potential breaking changes:
  • Python is now managed with poise-python cookbook


  • Readme update for faraday::cscan


  • faraday::cscan: Installs Faraday continuous scanning tool


  • Initial release of faraday cookbook

No quality metric results found