-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Installation
The following installation instructions are suitable for Linux and Mac OSX operating systems.
In theory, BeEF should work on any operating system which can run Ruby 2.5+ and nodejs. However, only MacOS and Linux are officially supported.
It is very easy to get BeEF setup with the basic pre-requisites.
You just need the following:
- Supported Ruby version
- The repository
- Run
./install
BeEF requires Ruby 2.5 (or newer). Refer to your operating system documentation for instructions to install the latest stable version of Ruby and Ruby-dev.
Debian based systems
sudo apt-get install ruby ruby-dev
RedHat / Fedora
sudo yum install ruby ruby-devel
If your operating system package manager does not support Ruby version 2.5 (or newer), you can add the brightbox ppa repository for the latest version of Ruby:
$ sudo apt-add-repository -y ppa:brightbox/ruby-ng
Alternatively, consider using a Ruby environment manager such as rbenv or rvm to manage your Ruby versions.
Bundler is essential for tracking and installing the correct gems in ruby projects. When installing, you may get the error:
$ line 208: bundle: command not found
This just means you do not have bundler installed, to fix this simply run:
$ gem install bundler
Obtain application source code either by downloading the latest archive:
$ wget https://github.com/beefproject/beef/archive/master.zip
Or cloning the Git repository from Github:
$ git clone https://github.com/beefproject/beef
Once a suitable version of Ruby is installed, run the install script in the BeEF directory:
$ ./install
This script installs the required operating system packages and all the prerequisite Ruby gems.
Upon successful installation, be sure to read the Configuration page on the wiki for important details on configuring and securing BeEF.
To start BeEF, first change the username and password config.yaml and then simply run:
$ ./beef
If you want to install the test pre-requisites just run
$bundle install --with test
This will install the pre-requisite gem's for tests.
If you want to run the test suit run:
$bundle exec rake
Due to the fast-paced nature of web browser development and webappsec landscape, it's best to regularly update BeEF to the latest version.
If you're using BeEF from the GitHub repository, updating is as simple as:
$ git pull
- Configuration
- Interface
- Information Gathering
- Social Engineering
- Network Discovery
- Metasploit
- Tunneling
- XSS Rays
- Persistence
- Creating a Module
- Geolocation
- Using-BeEF-With-NGROK