Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
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.3+ and nodejs. However, only MacOS and Linux are officially supported.
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
BeEF requires Ruby 2.3 (or newer). Refer to your operating system documentation for instructions to install the latest stable version of Ruby.
# 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.3 (or newer), you can add the brightbox ppa repository for the latest version of Ruby:
$ sudo apt-add-repository -y ppa:brightbox/ruby-ng
Once a suitable version of Ruby is installed, run the install script in the BeEF directory:
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, simply run:
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