Skip to content

Faraday Manage

Faraday Manage is a backend tool that helps us administrate Faraday's configuration.

To use Faraday Manage, you can run it as follow:

$ faraday-manage COMMAND

If you run only faraday-manage, it will list you all the available commands.

Available Commands

add-custom-field

This command allows you to create Custom Fields from the terminal. For more information about Custom Fields, you can see their wiki page

change-password

It allows you to change your user's password

create-superuser

The name says it all! This is the way to create a new admin user through the command line.

create-tables

This command allows the user to manually create a table on Faraday's database. It would come in handy if something in the initdb command fails for example.

database-schema

This will print a PNG image with Faraday's internal working scheme.

delete-custom-field

It allows you to delete a Custom Field from terminal

generate-nginx-config

This command displays the nginx config example to be added in nginx config

generate-roles-permission

This command displays the roles permission in a JSON file

generate-rsa-keys

It will create an RSA key for integrations

find-duplicate-vulns

Find duplicate vulnerabilities matching with Faraday knowledge database.

import-knowledge-base

Imports vulnerabilities knowledge base to Faraday DB.

import-license

Imports Faraday License.

import-methodologies

Imports methodologies and tasks from a csv file

import-vulnerability-templates

Imports vuln templates from a file

initdb

This command needs to be executed only at the moment of Faraday's installation. It will create the tables of the database, Faraday's user among other things.

If you try to execute this a second time it will indeed fail.

Danger

Warning: Please do not lose the random password that this command will print on the screen. It will be necessary to login into Faraday.

list-plugins

Lists available plugins.

migrate

Migrates database schema.

openapi-yaml

Show URLs in OpenApi format

rename-user

Change username.

settings

It allows you to manage settings inside faraday configuration

show-urls

Prints a list of all the URLs available to communicate with our API Rest.

sql-shell

This command will open a PostgreSQL shell already configured with Faraday's user and configuration.