update documentation for users

This commit is contained in:
Karl Mortensen 2015-04-21 14:50:37 -04:00
parent d346cb79ef
commit 3965ff7c24

View File

@ -1,8 +1,8 @@
Last Updated: Sept 17, 2014 Last Updated: 21 April 2015
This file outlines what it takes to build Autopsy from source. This file outlines what it takes to build Autopsy from source.
Note that it currently only works out of the box on Windows. We Note that it currently only works out-of-the-box on Windows. We
are working on getting the process working under non-Windows systems. are working on getting the process working under non-Windows systems.
It generally works, but needs some custom mangling to find the It generally works, but needs some custom mangling to find the
correct C libraries. correct C libraries.
@ -11,7 +11,9 @@ correct C libraries.
STEPS: STEPS:
1) Get Java Setup 1) Get Java Setup
1a) Download and install JDK version 1.8. You can now use 32-bit or 64-bit, but special work is needed to get The Sleuth Kit to compile as 64-bit. So, 32-bit is easier. 1a) Download and install JDK version 1.8. You can now use 32-bit or 64-bit, but
special work is needed to get The Sleuth Kit to compile as 64-bit. So, 32-bit
is easier, but if you intend to use PostgreSQL, choose 64-bit.
Autopsy has been used and tested with Oracle JavaSE and the included JavaFX support Autopsy has been used and tested with Oracle JavaSE and the included JavaFX support
(http://www.oracle.com/technetwork/java/javase/downloads/index.html). (http://www.oracle.com/technetwork/java/javase/downloads/index.html).
@ -28,8 +30,8 @@ but it is a recommended IDE to use for development of Autopsy modules.
need to set JRE_HOME_32 to the root 32-bit JRE directory and/or JRE_HOME_64 need to set JRE_HOME_32 to the root 32-bit JRE directory and/or JRE_HOME_64
to the root 64-bit JRE directory. to the root 64-bit JRE directory.
1e) (optional) For some Autopsy features to be functional, you need to add java executable to the system PATH. 1e) (optional) For some Autopsy features to be functional, you need to add the
java executable to the system PATH.
2) Get Sleuth Kit Setup 2) Get Sleuth Kit Setup
@ -43,18 +45,29 @@ our 64-bit version of libewf:
2b) Set LIBEWF_HOME environment variable to root directory of LIBEWF 2b) Set LIBEWF_HOME environment variable to root directory of LIBEWF
2c) Download and build a Release version of Sleuth Kit (TSK) 4.0. You 2c) Download and install PostgreSQL 9.4 or above. The official releases are
need to build the tsk_jni project. You can use a released version or from: http://www.postgresql.org/download/
download the latest from github:
2d) Set the POSTGRESQL_HOME_64 environment variable to point to the
PostgreSQL folder containing, but not including, the bin folder.
Example: POSTGRESQL_HOME_64=C:\Program Files\PostgreSQL\9.4
2d) Download and build a Release version of Sleuth Kit (TSK) 4.0. See
win32\BUILDING.txt in the TSK package for more information. You need to
build the tsk_jni project. Select the Debug_PostgreSQL x64 or
Release_PostgreSQL x64 target. You can use a released version or download
the latest from github:
- git://github.com/sleuthkit/sleuthkit.git - git://github.com/sleuthkit/sleuthkit.git
2d) Build the TSK JAR file by typing 'ant' in bindings/java in the 2e) Build the TSK JAR file by typing 'ant PostgreSQL' in bindings/java in the
TSK source code folder from a command line. You can also add the TSK source code folder from a command line. Note it is case sensitive. You
code to a NetBeans project and build it from there. can also add the code to a NetBeans project and build it from there,
selecting the PostgreSQL target. For TSK, the default is SQLite, which is
not enough for Autopsy. You must use the PostgreSQL target.
2e) Set TSK_HOME environment variable to the root directory of TSK 2f) Set TSK_HOME environment variable to the root directory of TSK
2f) On Non-Windows systems, you will need to do a 'make install' 2g) On Non-Windows systems, you will need to do a 'make install'
from the TSK root directory to install the libraries and such in from the TSK root directory to install the libraries and such in
the needed places (i.e. '/usr/local'). the needed places (i.e. '/usr/local').
@ -85,12 +98,13 @@ and by submitting pull requests to the main Autopsy repository.
5) Compile Autopsy 5) Compile Autopsy
5a) using Netbeans IDE: 5a) using Netbeans IDE:
- Start NetBeans IDE and open the Autopsy project. - Start NetBeans IDE and open the Autopsy project.
- Choose to build the Autopsy project / module. It is the highest - To build Autopsy, PostgreSQL is required to be installed.
level project that will then cause the other modules to be compiled. - Choose to build the Autopsy project / module. It is the highest level project
that will cause the other modules to be compiled.
5b) without Netbeans IDE (requires JDK and ant >= 1.7.1): 5b) without Netbeans IDE (requires JDK and ant >= 1.7.1):
- from root directory of Autopsy source execute: - from root directory of Autopsy source execute:
ant build ant
(to build Autopsy) (to build Autopsy)
ant run ant run
(to run Autopsy) (to run Autopsy)
@ -102,8 +116,10 @@ the build process.
- The Sleuth Kit Java datamodel JAR file has native JNI libraries - The Sleuth Kit Java datamodel JAR file has native JNI libraries
that are copied into it. These JNI libraries have dependencies on that are copied into it. These JNI libraries have dependencies on
libewf and zlib. On non-Windows platforms, the JNI library also has libewf and zlib. If you are using PostgreSQL, the dependencies are on libewf,
a dependency on libtsk (on Windows, it is compiled into libtsk_jni). zlib, libpq, libintl-8, libeay32, and ssleay32 DLL files. On non-Windows
platforms, the JNI library also has a dependency on libtsk (on Windows,
it is compiled into libtsk_jni).
- NetBeans uses ant to build Autopsy. The build target copies the - NetBeans uses ant to build Autopsy. The build target copies the
TSK datamodel JAR file into the project. If you want to use the TSK datamodel JAR file into the project. If you want to use the