Settings Reference¶

The faraday-manage settings command manages Faraday server configuration modules. Settings are stored in the database and affect server behavior at runtime.

settings¶

faraday-manage settings [OPTIONS] [NAME]

Options¶

Arguments¶

Actions¶

Examples¶

# List all available settings modules
faraday-manage settings
faraday-manage settings -a list

# Show current SMTP settings
faraday-manage settings -a show smtp

# Update ELK settings interactively (prompts for each field)
faraday-manage settings -a update elk

# Update settings non-interactively via JSON
faraday-manage settings -a update elk --data '{"enabled": true, "username": "elastic", "password": "changeme", "host": "https://localhost", "port": 9200, "ignore_ssl": false}'

# Reset dashboard settings to defaults
faraday-manage settings -a clear dashboard

Non-Interactive Updates¶

When using --data with JSON, all fields must be provided with the correct types. Missing or mistyped fields will cause an error:

Missing or Invalid value for <field_name> [<provided_value>]

After a non-interactive update, changes are applied without a confirmation prompt.

Interactive Updates¶

Without --data, the command prompts for each field showing the current value as default. After entering all values, a confirmation prompt is displayed:

Do you confirm your changes on smtp?
----------------------
enabled: True
username: notifications@example.com
...

Important: After modifying settings, restart the Faraday server for changes to take effect:

systemctl restart faraday-server

Available Settings Modules¶

Community Edition¶

Commercial/Professional Edition Only¶

SMTP¶

Email server configuration for Faraday notifications.

Settings ID: smtp

* Required when enabled is true. If SMTP is enabled, username, password, and host must not be empty.

Validation¶

When enabled is true, the command validates that username, password, and host are non-empty. Empty values produce:

<field> is required if smtp is enabled

Example¶

# Interactive setup
faraday-manage settings -a update smtp

# Non-interactive setup
faraday-manage settings -a update smtp --data '{
  "enabled": true,
  "username": "notifications@company.com",
  "password": "smtp-password",
  "host": "smtp.company.com",
  "port": 587,
  "sender": "faraday@company.com",
  "ssl": true
}'

Dashboard¶

Dashboard display configuration.

Settings ID: dashboard

Example¶

faraday-manage settings -a show dashboard

faraday-manage settings -a update dashboard --data '{"show_vulns_by_price": true}'

Reports¶

Report generation settings, including custom plugin directory configuration.

Settings ID: reports

Validation¶

If custom_plugins_folder is specified, it must be an existing directory on the filesystem. An invalid path produces:

<path> is not valid path

Example¶

# Show current reports settings
faraday-manage settings -a show reports

# Set custom plugins folder
faraday-manage settings -a update reports --data '{"custom_plugins_folder": "/opt/faraday/custom-plugins"}'

ELK¶

Elasticsearch integration settings. Used by the faraday-manage ingest command to connect to an Elasticsearch instance for vulnerability data indexing.

Settings ID: elk

* Required when enabled is true. All four fields (username, password, host, port) must be provided.

Validation¶

• When enabled is true: username, password, host, and port must all be non-empty
• For Python Elasticsearch client versions < 8: host must be a valid URL format (e.g., https://elasticsearch.example.com)
• For Python Elasticsearch client versions >= 8: host can be a hostname or URL

Example¶

# Configure Elasticsearch connection
faraday-manage settings -a update elk --data '{
  "enabled": true,
  "username": "elastic",
  "password": "changeme",
  "host": "https://elasticsearch.local",
  "port": 9200,
  "ignore_ssl": false
}'

# Test the connection after configuring
faraday-manage ingest --test-connection

Related¶

See [[integrations]] for the ingest command that uses these settings.

Query Limits¶

Configure limits on API query results to control resource usage.

Settings ID: query_limits

Example¶

# Show current query limits
faraday-manage settings -a show query_limits

# Set a limit of 10,000 vulnerabilities per query
faraday-manage settings -a update query_limits --data '{"vuln_query_limit": 10000}'

# Remove the limit (unlimited)
faraday-manage settings -a update query_limits --data '{"vuln_query_limit": 0}'

Commercial Edition Settings¶

The following settings modules are available in the Commercial/Professional edition only.

Executive Reports¶

Settings ID: executive_reports

faraday-manage settings -a update executive_reports
# markdown: True
# border_size: 3

SAML¶

Settings ID: saml

faraday-manage settings -a update saml