INSTALL 2.46 KB
BEFORE YOU START
----------------------------------

Binwalk supports Python 2.7 - 3.x.

The following installation procedures assume that you are installing binwalk to be run using Python 2.7.
If you want to use binwalk in Python 3, some package names and installation procedures may differ slightly.

You will also need to have a C compiler installed to build the supporting C libraries.



INSTALLATION
----------------------------------

Installation follows the typical configure/make process:

	$ ./configure
	$ make
	$ sudo make install

You can also install optional dependencies and extraction utilities (works on most Debian/RedHat based systems):

	$ make dependencies

Or see below for manaully installing optional dependencies / extraction utilities.



INSTALLING OPTIONAL DEPENDENCIES
----------------------------------

Binwalk has one (optional) dependency, used for generating graphs and plots:

	o pyqtgraph

You'll need to install the dependencies for pyqtgraph (you may also need to install OpenGL drivers for your video card):
	
	$ sudo apt-get install python-opengl python-qt4 python-qt4-gl python-numpy python-scipy

Most distros don't have pyqtgraph in their default repositories, so it's best to build it from source:

	$ wget http://www.pyqtgraph.org/downloads/pyqtgraph-0.9.8.tar.gz
	$ tar -zxvf pyqtgraph-0.9.8.tar.gz
	$ cd pyqtgraph-0.9.8 && sudo ./setup.py install



INSTALLING EXTRACTION UTILITIES
----------------------------------

Binwalk can automatically invoke external extraction utilities to extract various types of files that it
may find during a scan. These utilities are optional, but recommended if you plan on using binwalk's
extraction features.

Most utilities can be installed from your distro's repositories (package names may vary slightly based
on your particular distro):

	$ sudo apt-get install git mtd-utils zlib1g-dev liblzma-dev ncompress gzip bzip2 tar arj p7zip p7zip-full openjdk-6-jdk

However, the Firmware-Mod-Kit, which contains many file system extractors, needs to be built from source
and placed in the /opt/firmware-mod-kit directory:

	$ sudo mkdir -p /opt/firmware-mod-kit
	$ sudo chmod -R a+rwx /opt/firmware-mod-kit
	$ git clone https://code.google.com/p/firmware-mod-kit /opt/firmware-mod-kit/
	$ cd /opt/firmware-mod-kit/src && ./configure && make



UNINSTALL
----------------------------------

The following command will remove all installed libraries and modules (except for the extraction/optional dependencies):

	$ sudo make uninstall