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-attribute¶

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.

create workspace¶

Create workspace

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

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.

list-plugins¶

Lists available plugins.

load-samples¶

Loads pre-loaded samples for config, attributes, searchfilters, pipelines and planner

migrate¶

Migrates database schema.

openapi-yaml¶

Show URLs in OpenApi format

remove-rsa-keys¶

Remove RSA key pair generated for an...

rename-user¶

Change username.

settings¶

It allows you to manage settings inside faraday configuration

show-rsa-keys¶

Show RSA key pair for an integration's

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.

take-stats-snapshot¶

Generates vulnerabilities stats of the analytics and workspace view.

update-enrichment-database¶

Download latest enrichment database