faraday

(★ 6,690)

Open Source Vulnerability Management Platform

File Explorer

  • .dockerignore
  • .gitattributes
  • .gitignore
  • .gitlab-ci.yml
  • .pre-commit-config.yaml
  • .pylintrc
  • .python-version
  • architecture.md
  • AUTHORS
  • default.nix
  • docker-compose.yaml
  • Dockerfile
  • LICENSE
  • MANIFEST.in
  • pyproject.toml
  • README.md
  • RELEASE.md
  • release.nix
  • requirements.txt
  • requirements_dev.txt
  • requirements_extras.txt
  • SECURITY.md
  • setup.cfg
  • uv.lock

# Installation Guide

python

Setup Steps

wget https://raw.githubusercontent.com/infobyte/faraday/master/docker-compose.yaml

Download the docker-compose configuration file.

docker-compose up

Start services using Docker Compose.

pip3 install virtualenv

Install virtualenv for python environment.

virtualenv faraday_venv

Create a python virtual environment.

source faraday_venv/bin/activate

Activate the python virtual environment.

pip3 install .

Install the package and dependencies.

faraday-manage initdb

Initialize the database.

faraday-server

Run the Faraday server.

Key Commands

docker-compose up

Build and run the Faraday environment via Docker Compose.

pip3 install faradaysec

Install the Faraday security package from PyPI.

faraday-manage initdb

Initialize and set up the Faraday database schema.

faraday-server

Start the Faraday web server.

pip3 install faraday-cli

Install the Faraday CLI client.

Access http://localhost:5985 in your browser and login with the default username 'faraday' and the password provided during installation.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

docker run

View Details ▼

This command is an alias of `docker container run`.

tldr docker container run

View documentation for the original command:

🔍

git clone

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

pip3

View Details ▼

This command is an alias of `pip`.

tldr pip

View documentation for the original command:

🔍

virtualenv

View Details ▼

Create virtual isolated Python environments.

virtualenv {{path/to/venv}}

Create a new environment:

virtualenv --prompt {{prompt_prefix}} {{path/to/venv}}

Customize the prompt prefix:

virtualenv {{[-p|--python]}} {{path/to/pythonbin}} {{path/to/venv}}

Use a different version of Python with virtualenv:

# Project Badges

  • No description
  • No description
// repository documentation