mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-06 21:00:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

updates in documentation

Browse Source
This commit is contained in:
Greg DiCristofaro 2023-05-31 11:47:43 -04:00
parent 50c32c87ca
commit 95ed591029
10 changed files with 20 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
BUILDING.txt
View File

@ -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.

2
KeywordSearch/solr/bin/autopsy-solr.cmd
View File

@ -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

6
README.txt
View File

@ -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/

19
developers/envvarsetup.py
View File

@ -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)
set_var("JRE_HOME_64", open_jdk_64_home)
add_path([path_join(postgres_home, "bin"), ant_home])

4
docs/doxygen-user/multi-user/installActiveMQ.dox
View File

@ -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 (<a href="https://github.com/ojdkbuild/ojdkbuild/releases/download/java-1.8.0-openjdk-1.8.0.242-1.b08/java-1.8.0-openjdk-1.8.0.242-1.b08.ojdkbuild.windows.x86_64.msi"> Link to installer</a>)
- 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/ (<a href="https://bell-sw.com/pages/downloads/"> Link to download page</a>)
- Download ActiveMQ from: http://activemq.apache.org/download.html. Autopsy has been tested with ActiveMQ version 5.14.0.
\section install_activemq_install Installation

4
docs/doxygen-user/multi-user/installSolr.dox
View File

@ -17,7 +17,7 @@ NOTE: This document assumes you will be running Solr on Windows as a service. Yo
You will need:
<ul>
<li>A 64-bit version of the Java 8 Runtime Environment (JRE) from <a href="https://github.com/ojdkbuild/ojdkbuild">https://github.com/ojdkbuild/ojdkbuild</a>. (<a href="https://github.com/ojdkbuild/ojdkbuild/blob/master/README.md">Download links</a>)
<li>A 64-bit version of the Java 17 Runtime Environment (JRE) from <a href="https://bell-sw.com/pages/downloads/">https://bell-sw.com/pages/downloads/</a>. (<a href="https://bell-sw.com/pages/downloads/">Download links</a>)
<li>Pre-packaged Autopsy version of Solr from <a href="https://sourceforge.net/projects/autopsy/files/CollaborativeServices/Solr/SOLR_8.6.3_AutopsyService.zip/download">here</a>. This contains Solr, <a href="https://nssm.cc/">NSSM</a> to make it run as a service, and the needed schema config files.
<li>A network-accessible machine to install Solr on. Note that the Solr process may need to write to a shared storage drive (if that is how you configure it) and will therefore need adequate permissions.
</ul>
@ -52,7 +52,7 @@ Follow these steps to configure Solr:
Required Solr Configuration Parameters:
<ul>
<li><b>JAVA_HOME</b> – path to 64-bit JRE installation. For example \c "JAVA_HOME=C:\Program Files\Java\jre1.8.0_151" or \c "JAVA_HOME=C:\Program Files\ojdkbuild\java-1.8.0-openjdk-1.8.0.222-1"
<li><b>JAVA_HOME</b> – path to 64-bit JRE installation. For example \c "JAVA_HOME= C:\Program Files\BellSoft\LibericaJDK-17-Full" or \c "JAVA_HOME=C:\Program Files\BellSoft\LibericaJDK-17-Full"
<li><b>DEFAULT_CONFDIR</b> – path to Autopsy configuration directory. If the Solr archive was extracted into \c "C:\solr-8.6.3" directory, then this path will be \c "C:\ solr-8.6.3\server\solr\configsets\AutopsyConfig\conf". Do not include quotes around the path.
<li><b>SOLR_JAVA_MEM</b> - Solr JVM heap size should be as large as the Solr machine’s resources allow, at least half of the total RAM available on the machine. A rule of thumb would be use "set SOLR_JAVA_MEM=-Xms2G -Xmx40G" for a machine with 64GB of RAM, "set SOLR_JAVA_MEM=-Xms2G -Xmx20G" for a machine with 32GB of RAM, and "set SOLR_JAVA_MEM=-Xms2G -Xmx8G" for a machine with 16GB of RAM. Please see the \ref install_solr_heap_usage "troubleshooting section" for more info regarding Solr heap usage and troubleshooting information.
<li><b>SOLR_DATA_HOME</b> – location where Solr indexes will be stored. If this is not configured, the indexes will be stored in the \c "C:\solr-8.6.3\server\solr" directory. NOTE: for Autopsy cases consisting of large number of data sources, Solr indexes can get very large (hundreds of GBs, or TBs) so they should probably be stored on a larger network share.

2
docs/doxygen-user_fr/multi-user/installActiveMQ.dox
View File

@ -8,7 +8,7 @@ ActiveMQ est un service de messagerie qui permet aux clients Autopsy de communiq
\section install_activemq_prereq Conditions préalables
Vous aurez besoin de:
- Java Runtime Environment 8 (JRE) version 64 bits téléchargeable à partir de https://github.com/ojdkbuild/ojdkbuild (<a href="https://github.com/ojdkbuild/ojdkbuild/releases/download/java-1.8.0-openjdk-1.8.0.242-1.b08/java-1.8.0-openjdk-1.8.0.242-1.b08.ojdkbuild.windows.x86_64.msi"> Lien vers l'installateur</a>)
- Java Runtime Environment 17 (JRE) version 64 bits téléchargeable à partir de https://bell-sw.com/pages/downloads/ (<a href="https://bell-sw.com/pages/downloads/"> Lien vers l'installateur</a>)
- Télécharger ActiveMQ depuis: http://activemq.apache.org/download.html . Autopsy a été testé avec ActiveMQ version 5.14.0.

4
docs/doxygen-user_fr/multi-user/installSolr.dox
View File

@ -17,7 +17,7 @@ REMARQUE : ce document suppose que vous exécuterez Solr sur Windows en tant que
Vous aurez besoin de:
<ul>
<li>Une version 64 bits de Java 8 Runtime Environment (JRE) que vous pourrez trouver sur <a href="https://github.com/ojdkbuild/ojdkbuild">https://github.com/ojdkbuild/ojdkbuild</a>. (<a href="https://github.com/ojdkbuild/ojdkbuild/blob/master/README.md">Lien de téléchargement</a>)
<li>Une version 64 bits de Java 17 Runtime Environment (JRE) que vous pourrez trouver sur <a href="https://bell-sw.com/pages/downloads/</a>. (<a href="https://bell-sw.com/pages/downloads/">Lien de téléchargement</a>)
<li>Une version Autopsy pré-packagée avec Solr que vous pourrez trouver <a href="https://sourceforge.net/projects/autopsy/files/CollaborativeServices/Solr/SOLR_8.6.3_AutopsyService.zip/download">ici</a>. Cela contient Solr, <a href="https://nssm.cc/">NSSM</a> pour le faire fonctionner en tant que service, ainsi que les fichiers de configuration de schéma nécessaires.
<li>Une machine accessible en réseau sur laquelle installer Solr. Notez que le processus Solr peut avoir besoin d'écrire sur un lecteur de stockage partagé (si c'est ainsi que vous le configurez) et aura donc besoin des autorisations adéquates.
</ul>
@ -52,7 +52,7 @@ Suivez ces étapes pour configurer Solr:
Paramètres de configuration requis pour Solr:
<ul>
<li><b>JAVA_HOME</b> – chemin d'accès à l'installation du JRE 64 bits. Par exemple \c "JAVA_HOME=C:\Program Files\Java\jre1.8.0_151" ou \c "JAVA_HOME=C:\Program Files\ojdkbuild\java-1.8.0-openjdk-1.8.0.222-1"
<li><b>JAVA_HOME</b> – chemin d'accès à l'installation du JRE 64 bits. Par exemple \c "JAVA_HOME=C:\Program Files\Java\jre1.8.0_151" ou \c "JAVA_HOME=C:\Program Files\BellSoft\LibericaJDK-17-Full"
<li><b>DEFAULT_CONFDIR</b> – chemin vers le répertoire de configuration d'Autopsy. Si l'archive Solr a été extraite dans le répertoire \c "C:\solr-8.6.3", alors ce chemin sera \c "C:\ solr-8.6.3\server\solr\configsets\AutopsyConfig\conf". N'incluez pas de guillemets autour du chemin.
<li><b>SOLR_JAVA_MEM</b> - La taille du tas JVM Solr doit être aussi grande que les ressources de la machine Solr le permettent, au moins la moitié de la RAM totale disponible sur la machine. Une règle empirique serait d'utiliser "set SOLR_JAVA_MEM=-Xms2G -Xmx40G" pour une machine avec 64 Go de RAM, "set SOLR_JAVA_MEM=-Xms2G -Xmx20G" pour une machine avec 32 Go de RAM, et "set SOLR_JAVA_MEM=-Xms2G -Xmx8G" pour une machine avec 16 Go de RAM. Veuillez consulter la \ref install_solr_heap_usage "rubrique dépannage" pour plus d'informations sur l'utilisation du tas Solr et sur les informations de dépannage.
<li><b>SOLR_DATA_HOME</b> – emplacement où les index Solr seront stockés. Si ce n'est pas configuré, les index seront stockés dans le répertoire \c "C:\solr-8.6.3\server\solr". REMARQUE: pour les cas d'Autopsy composés d'un grand nombre de sources de données, les index Solr peuvent devenir très volumineux (des centaines de Go ou de To), ils devront donc probablement être stockés sur un partage réseau plus important.

2
docs/doxygen/modDev.dox
View File

@ -12,7 +12,7 @@ This page describes the basic concepts and setup that are needed for all types o
Autopsy is built on top of the NetBeans Rich Client Platform, which makes it easy to make plug-in infrastructures. To do any development, you really need to download NetBeans first. You can in theory develop modules by command line only, but this document assumes that you are using the IDE. Download and install the latest version of the IDE from http://www.netbeans.org.
Autopsy currently requires Java 1.8. Ensure that it is installed.
Autopsy currently requires Java 17. Ensure that it is installed.
\subsection mod_dev_setup_platform Obtain the Autopsy Platform

2
docs/doxygen/modDevPython.dox
View File

@ -33,7 +33,7 @@ To install NetBeans' plug-in:
-# Setup Jython path from Tools->Python Platforms, click on new, then choose Jython.exe (usually in C:\\Program files\\Jython2.7\\bin)
To install IntelliJ IDEA + Python plug-in:
-# Download java JDK depending on platform. Install to desired location (http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
-# Download java JDK depending on platform. Install to desired location (https://bell-sw.com/pages/downloads/).
-# Download and install IDEA Community Edition to desired location (https://www.jetbrains.com/idea/download/).
-# Open IDEA and choose desired UI theme. Continue with default settings.
-# Choose to either create a new empty project or open an existing one.