From 95ed5910290b034c337741751ce3cb8bbd9dac46 Mon Sep 17 00:00:00 2001 From: Greg DiCristofaro Date: Wed, 31 May 2023 11:47:43 -0400 Subject: [PATCH 1/7] updates in documentation --- BUILDING.txt | 7 ++----- KeywordSearch/solr/bin/autopsy-solr.cmd | 2 +- README.txt | 6 +++--- developers/envvarsetup.py | 21 +++++-------------- .../multi-user/installActiveMQ.dox | 4 ++-- docs/doxygen-user/multi-user/installSolr.dox | 4 ++-- .../multi-user/installActiveMQ.dox | 2 +- .../multi-user/installSolr.dox | 4 ++-- docs/doxygen/modDev.dox | 2 +- docs/doxygen/modDevPython.dox | 2 +- 10 files changed, 20 insertions(+), 34 deletions(-) diff --git a/BUILDING.txt b/BUILDING.txt index 8b09ad5d3f..8da32f6a76 100644 --- a/BUILDING.txt +++ b/BUILDING.txt @@ -11,12 +11,9 @@ correct C libraries. STEPS: 1) Get Java Setup -1a) Download and install JDK version 1.8. For the current version of JavaFX -that we use, you'll need 1.8.0_66 or greater. You can now use 32-bit or 64-bit, -but special work is needed to get The Sleuth Kit to compile as 64-bit. +1a) Download and install 64-bit JDK version 17 with JavaFX. -Autopsy has been used and tested with the following OpenJDK build -(https://github.com/ojdkbuild/ojdkbuild/releases/tag/java-1.8.0-openjdk-1.8.0.222-1.b10). +Autopsy has been used and tested with liberica java which can be downloaded from here: https://bell-sw.com/pages/downloads/. 1b) Ensure that JDK_HOME is set to the root JDK directory. diff --git a/KeywordSearch/solr/bin/autopsy-solr.cmd b/KeywordSearch/solr/bin/autopsy-solr.cmd index 37dbc22a03..9e1ec90d88 100755 --- a/KeywordSearch/solr/bin/autopsy-solr.cmd +++ b/KeywordSearch/solr/bin/autopsy-solr.cmd @@ -1,4 +1,4 @@ -@REM set JAVA_HOME=C:\Program Files\ojdkbuild\java-1.8.0-openjdk-1.8.0.222-1 +@REM set JAVA_HOME=C:\Program Files\BellSoft\LibericaJDK-17-Full @REM set SOLR_SERVER_DIR=C:\Bitnami\solr-8.2.0-2/apache-solr/server set SOLR_PORT=8983 set STOP_PORT=8079 diff --git a/README.txt b/README.txt index 3fb1455b14..063d6bc7a7 100644 --- a/README.txt +++ b/README.txt @@ -42,9 +42,9 @@ EMBEDDED SOFTWARE This section lists the software components and libraries that are used by Autopsy. These tools are bundled with the Windows installer, unless specified otherwise. -JRE (Java Runtime Environment) 1.8 -- Web page: http://www.oracle.com/technetwork/java/index.html -- License: http://www.oracle.com/technetwork/java/javase/terms/license/index.html +JRE (Java Runtime Environment) 17 +- Web page: https://bell-sw.com/pages/downloads/ +- License: https://bell-sw.com/liberica_eula/ Netbeans 15 RCP platform and .jar files bundled with the platform - Web page: https://netbeans.apache.org/ diff --git a/developers/envvarsetup.py b/developers/envvarsetup.py index 1e872bd28a..b0709ff004 100755 --- a/developers/envvarsetup.py +++ b/developers/envvarsetup.py @@ -34,11 +34,9 @@ open_jdk_64_home is the 64 bit jdk and is the assumed default source_base_path is the directory containing all necessary repos (i.e. autopsy, sleuthkit, etc.) open_jdk_32_home and postgres_32_home are only necessary if building binaries ''' -open_jdk_64_home = "C:\\Program Files\\ojdkbuild\\java-1.8.0-openjdk-1.8.0.222-1" +open_jdk_64_home = "C:\\Program Files\\BellSoft\\LibericaJDK-17-Full" postgres_home = "C:\\Program Files\\PostgreSQL\\9.5" -ant_home = "C:\\Program Files\\NetBeans 8.2\\extide\\ant" -open_jdk_32_home = "C:\\Program Files (x86)\\ojdkbuild\\java-1.8.0-openjdk-1.8.0.222-1" -postgres_32_home = "C:\\Program Files (x86)\\PostgreSQL\\9.5" +ant_home = "C:\\Program Files\\NetBeans-17\\netbeans\\extide\\ant" open_jdk_home = open_jdk_64_home @@ -60,17 +58,8 @@ def add_path(paths): set_var("JAVA_HOME", open_jdk_home) -set_var("JRE_HOME", path_join(open_jdk_home, "jre")) +set_var("JRE_HOME", open_jdk_home) set_var("JDK_HOME", open_jdk_home) -set_var("POSTGRESQL_HOME_64", postgres_home) set_var("TSK_HOME", path_join(source_base_path, "sleuthkit")) - -set_var("JDK_HOME_64", open_jdk_64_home) -set_var("JRE_HOME_64", path_join(open_jdk_64_home, "jre")) - -set_var("JDK_HOME_32", open_jdk_32_home) -set_var("JRE_HOME_32", path_join(open_jdk_32_home, "jre")) - -set_var("POSTGRESQL_HOME_32", postgres_32_home) - -add_path([path_join(postgres_home, "bin"), ant_home]) \ No newline at end of file +set_var("JRE_HOME_64", open_jdk_64_home) +add_path([path_join(postgres_home, "bin"), ant_home]) diff --git a/docs/doxygen-user/multi-user/installActiveMQ.dox b/docs/doxygen-user/multi-user/installActiveMQ.dox index a165bacd74..d668ab006d 100644 --- a/docs/doxygen-user/multi-user/installActiveMQ.dox +++ b/docs/doxygen-user/multi-user/installActiveMQ.dox @@ -8,8 +8,8 @@ ActiveMQ is a messaging service that allows the Autopsy clients to communicate w \section install_activemq_prereq Prerequisites You will need: -- 64-bit version of the Java 8 Runtime Environment (JRE) from https://github.com/ojdkbuild/ojdkbuild ( Link to installer) -- Download ActiveMQ from: http://activemq.apache.org/download.html . Autopsy has been tested with ActiveMQ version 5.14.0. Note that newer versions will not work with Java 8. +- 64-bit version of the Java 17 Runtime Environment (JRE) from https://bell-sw.com/pages/downloads/ ( Link to download page) +- Download ActiveMQ from: http://activemq.apache.org/download.html. Autopsy has been tested with ActiveMQ version 5.14.0. \section install_activemq_install Installation diff --git a/docs/doxygen-user/multi-user/installSolr.dox b/docs/doxygen-user/multi-user/installSolr.dox index c2a25520c8..587eeca9cd 100644 --- a/docs/doxygen-user/multi-user/installSolr.dox +++ b/docs/doxygen-user/multi-user/installSolr.dox @@ -17,7 +17,7 @@ NOTE: This document assumes you will be running Solr on Windows as a service. Yo You will need: @@ -52,7 +52,7 @@ Follow these steps to configure Solr: Required Solr Configuration Parameters: