Installation ============= Bulk Reviewer is currently available for Linux and macOS. Dependencies ------------ Bulk Reviewer requires that the following programs are installed on the same computer and that their command line interfaces are available on the system path: * `bulk_extractor `_: Bulk Reviewer is compatible with bulk_extractor 1.5.5+. Scanning for Canadian Social Insurance Numbers (SINs) requires bulk_extractor version 1.6.0-dev, built from commit `f4ac85d `_ or later. * `The Sleuth Kit `_ For Bulk Reviewer to be able to handle Encase/E01 disk images, bulk_extractor and The Sleuth Kit must be built with `libewf `_. These dependencies should already be installed in the `BitCurator Environment `_ (unless you need to scan for Canadian SINs, in which case bulk_extractor will need to be rebuilt from source). Recommended hardware specs -------------------------- bulk_extractor is a computationally intensive tool which scales linearly to the number of processor cores available to it. Although Bulk Reviewer will work on most systems, it may be prohibitively slow on computers with fewer than four cores. Bulk Reviewer has been developed and primarily tested on a 2015 Macbook Pro with a quad-core i5 CPU and 16 GB RAM. For production systems, a recent CPU with 4+ cores and at least 8 GB of RAM is recommended. Installation in BitCurator -------------------------- 1. Download the ``BulkReviewer-x.x.x.AppImage`` `AppImage `_ from the `latest Bulk Reviewer release `_. 2. Move the AppImage to the "Forensics and Reporting" folder or another appropriate location on the BitCurator desktop. 3. Make the Bulk Reviewer AppImage executable (right-click on the AppImage file, select Properties, and then select "Allow executing file as program" under the Permissions tab; or change the file permissions with ``chmod u+x`` in a terminal). 4. Double-click the AppImage. A prompt will ask if you want to integrate Bulk Reviewer with your system. Choose "Yes" to install Bulk Reviewer. From this point forward, Bulk Reviewer can be launched by selecting it from the Applications menu or double-clicking on the AppImage file in the "Forensics and Reporting" folder. Installation in Ubuntu 18.04 ---------------------------- 1. Install dependencies in a terminal: .. code-block:: none wget "https://github.com/bulk-reviewer/bulk-reviewer/blob/master/install_ubuntu18.sh" chmod a+x install_ubuntu18.sh sudo ./install_ubuntu18.sh 2. Download the ``BulkReviewer-x.x.x.AppImage`` `AppImage `_ from the `latest Bulk Reviewer release `_. 3. Move the AppImage to your home directory or desktop and make the file executable (right-click on the AppImage file, select Properties, and then select "Allow executing file as program" under the Permissions tab; or change the file permissions with ``chmod u+x`` in a terminal). 4. Double-click the AppImage. A prompt will ask if you want to integrate Bulk Reviewer with your system. Choose "Yes" to install Bulk Reviewer. From this point forward, Bulk Reviewer can be launched by selecting it from the Applications menu or double-clicking on the AppImage file. Installation in macOS --------------------- 1. Make sure you have `Homebrew `_ and `XCode `_ installed. 2. Download the ``install_mac.sh`` script from the Bulk Reviewer Github repository. 3. In a terminal, change directory to where you saved the `install_mac.sh` script and install dependencies: .. code-block:: none brew install libewf afflib sleuthkit chmod a+x install_mac.sh ./install_mac.sh 4. Download the `BulkReviewer-x.x.x.dmg` from the `latest Bulk Reviewer release `_. 5. Double-click the dmg to open the Bulk Reviewer installer. Drag the Bulk Reviewer icon to the Applications folder to install.