README

   Copyright 2011 Wade Alcorn wade@bindshell.net

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Most of the contents of this file will eventually be added to /install.rb. In the meantime tips, hints and guides for installing BeEF should be kept here.

=============================================

   1. Prerequisites (platform independent)
   2. Prerequisites (Windows)
   3. Prerequisites (Linux)
   4. Prerequisites (Mac OSX)
   5. Install instructions
   6. Run instructions



   1. Prerequisites (platform independent)

      BeEF requires ruby 1.9 and the "bundler" gem. Bundler can be installed by:

      gem install bundler

      
   2. Prerequisites (Windows)
      
      Windows requires the sqlite.dll.  Simply grab the zip file below and extract it to your Ruby bin directory:

	  http://www.sqlite.org/sqlitedll-3_7_0_1.zip
      

   3. Prerequisites (Linux)

      !!! This must be done PRIOR to running the bundle install command !!!
      
      On linux you will need to find the packages specific to your distribution for sqlite.  An example for Ubuntu systems is:

	  sudo apt-get install libsqlite3-dev sqlite3 sqlite3-doc
	  
	  
	  You also need to install the ruby-dev package (required for mkmf)
	  
	  sudo apt-get install ruby-dev
	  
	  
   4. Prerequisites (Mac OSX)
   
      Make sure you have XCode installed - which provided the sqlite support BeEF needs
      Sqlite support is native in MacOS 10.6+
      

   5. Install instructions
   
      Obtain application code either by downloading an archive from https://github.com/beefproject/beef/zipball/master or cloning the GIT repo git@github.com:beefproject/beef.git

	  Navigate to the ruby source directory and run:

	  bundle install

      Bundler installs all the pre-requisite gems.

   6. Run instructions

      Simply run:

      ./beef