Getting Started¶

Faraday is a collaborative vulnerability management platform that centralizes security findings from 120+ tools into a single workspace. Whether you run scans manually, automate them with agents, or integrate via CI/CD pipelines, Faraday gives your team a unified view of your security posture.

Quick Overview¶

┌─────────────────────────────────────────────────────────┐
│                    Data Sources                         │
│  ┌──────────┐  ┌──────────┐  ┌──────────┐  ┌─────────┐  │
│  │  Manual  │  │  Report  │  │  Faraday │  │  REST   │  │
│  │  Scans   │  │  Upload  │  │  Agents  │  │  API    │  │
│  └─────┬────┘  └─────┬────┘  └─────┬────┘  └────┬────┘  │
└────────┼─────────────┼─────────────┼────────────┼───────┘
         │             │             │            │
         └──────────┬──┴─────────────┴────────────┘
                    ▼
          ┌─────────────────┐
          │  Faraday Server │
          │  (Flask + API)  │
          └────────┬────────┘
                   ▼
          ┌─────────────────┐
          │   Workspaces    │
          │ ┌─────────────┐ │
          │ │   Assets    │ │
          │ │   Services  │ │
          │ │   Vulns     │ │
          │ └─────────────┘ │
          └────────┬────────┘
                   ▼
    ┌──────────────┴───────────────┐
    │    Analysis & Reporting      │
    │  Dashboard · Reports · API   │
    │  Jira · GitLab · ServiceNow  │
    └──────────────────────────────┘

Choose Your Path¶

I want to try Faraday quickly¶

1. Install via Docker Compose — the fastest path to a running instance:

   curl -O https://raw.githubusercontent.com/infobyte/faraday/master/docker-compose.yaml
   docker compose up -d
   

2. Log in at http://localhost:5985
3. Follow the First Steps guide to create a workspace and import your first scan

I want to set up Faraday for my team¶

1. Choose an installation method from the Installation Guide:
   • Docker Compose (recommended for production)
   • Ubuntu / Debian / Kali
   • RHEL 8+ / CentOS / Rocky
   • Community Edition (pip)
2. Configure NGINX and TLS using the Advanced Install Guide for production-grade deployments
3. Create user accounts and assign roles (admin, pentester, asset owner, client)
4. Set up integrations with your ticketing system (Jira, GitLab, ServiceNow, Web Help Desk, ServiceDesk)

I want to automate scanning¶

1. Install the Faraday CLI to run tools and import results from the command line
2. Set up Faraday Agents to run scheduled scans with tools like Nmap, Nessus, Nuclei, and more
3. Integrate with CI/CD to scan automatically on every deployment

I want to integrate via API¶

1. Generate an API token — see API Token
2. Explore the API — see the Interactive API Reference (Swagger UI)
3. Build your integration using the REST API to create hosts, services, and vulnerabilities programmatically

Integrating Faraday in Your Workflow¶

Supported Tools¶

Faraday processes output from 120+ security tools. See the full Supported Plugins list. Popular tools include:

Data Import Methods¶

CI/CD Integration¶

Integrate Faraday into your deployment pipeline to scan automatically:

• GitHub Actions — Use Faraday CLI in your workflow steps
• GitLab CI/CD — Import results as a pipeline job
• Jenkins — Run tools and push results via CLI or API

Resources¶