Skip to content

Install-Guide.md

Latest commit

 

History

History
225 lines (141 loc) · 6.75 KB

Install-Guide.md

File metadata and controls

225 lines (141 loc) · 6.75 KB
Raw

Faraday's installers (.deb or .rpm) will install Faraday Server as a service.

Faraday Server is the interface between PostgreSQL and Faraday Client and the WebUI. The Server's responsibility is to transmit information between the client or WebUI and PostgreSQL, and make sure that they are kept in sync.

It is recommended to install Faraday Server on the same instance as PostgreSQL and use a reverse proxy server when deploying to production. See Nginx setup for instructions.

Debian/Ubuntu/Kali

  1. Download Faraday's installer from our Github project.

  2. Install postgresql >= 9.6 (locally or in a remote server). In order to install PostgreSQL, you can run the following command:

$ sudo apt install postgresql

  1. After the installation is completed, verify that PostgreSQL version is higher or equal than 9.6 by running:

$ psql -c "SELECT version()" postgres

  1. Go to your Download directory and run the following command:

$ sudo apt install ./yourInstallFileName.deb

  1. If PostgreSQL is running in a remote machine please follow these instructions. If, instead, it is running locally, simply run:

$ sudo faraday-manage initdb

  1. Start Faraday's server by running:

$ systemctl start faraday-server

To know how to run Faraday's multiple commands, please follow this link.

CentOS7/RedHat7

Before installation

Please note that PostgreSQL YUM repository and Faraday, depend on EPEL repository for some packages. Users with RHEL, CentOS, etc. should install EPEL repo RPM along with PGDG repo RPMs to satisfy dependencies. In order to do that, follow these instructions:

If you are using RHEL, first run the following command:

$ subscription-manager repos --enable rhel-7-server-optional-rpms --enable rhel-7-server-extras-rpms

Run the following commands to install EPEL repo in RHEL or CentOS:

$ curl -o epel.rpm http://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
$ rpm -Uvh epel.rpm

Installing Faraday

  1. Download Faraday's installer from our Github project.

  2. Install postgresql >= 9.6 (locally or in a remote server). In order to install PostgreSQL, you can run follow the guide from postgresql website

  3. After the installation is completed, verify that PostgreSQL version is higher than 9.6 by running:

$ psql -c "SELECT version()" postgres

  1. Go to your Download directory and run the following command:

$ sudo yum install ./yourInstallFileName.rpm

  1. If PostgreSQL is running in a remote machine please follow these instructions. If, instead, it is running locally, you need to open the pg_hba.conf file. There, you need to modify the localhost authentication type from "ident" to "md5". To do this, change host IPV4 local and IPV6 local from "ident" to "md5":

    Open the pg_hba.conf file (remember to specify the right PostgreSQL version):

    $ nano /var/lib/pgsql/POSTGRESQL_VERSION/data/pg\_hba.conf

    Once you have opened the file, you need to edit the following lines so the authentication type is set from "ident" to "md5":

    # IPv4 local connections:
host    all             all             127.0.0.1/32            md5
# IPv6 local connections:
host    all             all             ::1/128                 md5

  2. Restart PostgreSQL server and initialize the database:

$ sudo systemctl restart postgresql
$ sudo faraday-manage initdb
  1. Start Faraday's server by running:

$ systemctl start faraday-server

To know how to run Faraday's multiple commands, please follow this link.

Mac OSx

Instructions for Faraday's installation in Mac OSx are specified in this installation guide.

Binary files

Downloading Faraday

  1. Download Faraday's installer from our Github project

  2. Once you have downloaded the package, you need to unzip it:

$ unzip linux_binaries.zip

This binary package contains four executable files:

  • faraday-client
  • faraday-server
  • faraday-manage
  • faraday-fplugin
  1. In order to install Faraday, please run the file faraday-server:
$ ./faraday-server

Once the installation is completed, we can run every executable file as follow:

  • To run Faraday's Server:

    $ ./faraday-server

  • To run Faraday's Client:

    $ ./faraday-client

  • To run Faraday's Manage:

    $ ./faraday-manage

  • To run Faraday's Plugin:

    $ ./faraday-fplugin

Installation from PyPI

You can install Faraday from PyPI by running the following command:

$ pip install faradaysec

After installation

Once the installation is completed, we can start Faraday's server by running:

$ faraday-server

To know how to run Faraday's multiple commands, please follow this link.

Installation from Git repo

In order to install Faraday's Community version, you can use pip to install Faraday or you can clone the repository.

Before installing Faraday, we need to create a virtualenv so Faraday runs in it. In order to install and create a virtualenv, run the following commands:

$ pip install virtualenv
$ virtualenv faraday_venv
$ source faraday_env/bin/activate

For more information about virtualenv, please follow this link.

Installing Faraday

  • Installing using Pip
$ pip install git+git@github.com:infobyte/faraday.git
  • Cloning the repository:
$ git clone --depth 1 git@github.com:infobyte/faraday.git
$ cd faraday-dev/
$ python setup.py install

After installation

Once the installation is completed, we can start Faraday's server by running:

$ faraday-server

To know how to run Faraday's multiple commands, please follow this link.