Faraday Manage

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 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 this KB 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.

find-duplicate-vulns

Find duplicate vulnerabilities matching with Faraday knowledge database.

import-knowledge-base

Import vulnerabilities knowledge base to Faraday DB.

import-license

Import Faraday License.

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.

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.

rename-user

Change username.

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.

status_check

This command will check the state in which Faraday is. It checks that:

  • PostgreSQL is running,
  • Faraday Server and Client are running,
  • the configuration is okay,
  • the dependencies are installed.

You can run this command with the following parameters:

--check_postgresql

--check_faraday

--check_dependencies

--check_config

support

Generates a .zip file with technical information for support purposes.


    Still looking for answers? You can try opening a ticket.
      • Related Articles

      • Faraday Server

        Faraday's installers (.deb or .rpm) will install Faraday Server as a service. Faraday Server is the interface between PostgreSQL, Faraday Client and the WebUI. The Server's responsibility is to transmit information between the Client or WebUI and ...
      • Updating Faraday

        Faraday will be installed as a service if you use .deb or .rpm.  Note: if you're updating from Faraday v3.8.1 or lower, follow the instructions specified in the last section of this article. Once you're done, you can proceed with the instructions ...
      • How to reset Faraday Server password

        If you forgot the password or you don't know your Faraday Server password, you can use the command faraday-manage to change it: $ faraday-manage change-password
      • Faraday Plugin

        Intro In order to manage, add, and list information stored in faraday, we created fplugin, a simple plugin that allows you to interact directly with our Python API from the command line. It gives Faraday powerful scripting features and allows you to ...
      • Faraday Client

        GTK To access Faraday GTK, run faraday-client in the instance where you installed your Faraday Client .deb or .rpm (or .pkg, in Mac). You will be presented with a special version of your own ZSH terminal . Just as with GTK, Faraday intercepts every ...