From f60219c04a886e5c3a8151f074f8f333d779b12d Mon Sep 17 00:00:00 2001
From: Brian Carrier <carrier@sleuthkit.org>
Date: Fri, 23 Dec 2022 16:43:02 -0500
Subject: [PATCH] Added more details to cluster setup

---
 docs/doxygen-user/multi-user/installActiveMQ.dox | 12 ++++++++----
 docs/doxygen-user/multi-user/installPostgres.dox |  6 ++++--
 docs/doxygen-user/multi-user/installSolr.dox     |  4 ++++
 3 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/docs/doxygen-user/multi-user/installActiveMQ.dox b/docs/doxygen-user/multi-user/installActiveMQ.dox
index 5cedc7b348..a165bacd74 100644
--- a/docs/doxygen-user/multi-user/installActiveMQ.dox
+++ b/docs/doxygen-user/multi-user/installActiveMQ.dox
@@ -9,7 +9,7 @@ ActiveMQ is a messaging service that allows the Autopsy clients to communicate w
 
 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.
+- 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. 
 
 
 \section install_activemq_install Installation
@@ -29,7 +29,9 @@ If you need the JRE, install it with the default settings.
 
 <li>Open the <i>conf\\activemq.xml</i> file in the extracted folder in a text editor and make the following changes:
 <ul>
-<li> Add <i>"schedulePeriodForDestinationPurge="10000""</i> to the _broker_ tag then add <i>"gcInactiveDestinations="true" inactiveTimoutBeforeGC="30000""</i> to the _policyEntry_ tag. This is highlighted in yellow below:
+<li> Add <i>"schedulePeriodForDestinationPurge="10000""</i> to the _broker_ tag</li>
+<li> Add <i>"gcInactiveDestinations="true" inactiveTimoutBeforeGC="30000""</i> to the _policyEntry_ tag. 
+<li> These are both highlighted in yellow below:
 
 \image html activeMQ_node_cleanup.png
 
@@ -41,6 +43,8 @@ If you need the JRE, install it with the default settings.
 
 <li>Install ActiveMQ as a service by navigating to the folder <i>bin\\win64</i>, right-clicking _InstallService.bat_, clicking _Run as administrator_, then click _Yes_.
 
+<li>Add the bin\\win64\\wrapper.exe and java.exe (from the JRE) to the Windows firewall so that they can accept network communications.
+
 <li>Start the ActiveMQ service by pressing _Start_, type _services.msc_, and press _Enter_. Find _ActiveMQ_ in the list and press the _Start the service_ link.
 
 <li>ActiveMQ should now be installed and configured using the default credentials. 
@@ -48,7 +52,7 @@ If you need the JRE, install it with the default settings.
 
 \subsection install_activemq_test Testing
 
-To test your installation, you can access the admin pages in your web browser via a URL like this: http://localhost:8161/admin. 
+To test your installation, you can access the admin pages in your web browser (on the server) via a URL like this: http://localhost:8161/admin. NOTE that you cannot access this page from other hosts unless you go into jetty.xml and change org.apache.activemq.web.WebConsolePort so that host is 0.0.0.0 (and ensure that it is properly secured). 
 
 The default administrator username is _admin_ with a password of _admin_ and the default regular username is _user_ with a default password of _password_.  You can change these passwords by following the instructions below. 
 
@@ -57,7 +61,7 @@ If you can see a page that looks like the following, it confirms that the Active
 \image html activemq.PNG
 <br><br>
 
-You can confirm that your ActiveMQ installation is visible to other computers on the network by attempting to connect to a URL like the following (replacing the host name with that of the ActiveMQ computer) in a web browser: http://activemq-computer:61616
+You can also confirm that your ActiveMQ installation is visible to other computers on the network by attempting to connect to a URL like the following (replacing the host name with that of the ActiveMQ computer) in a web browser: http://activemq-computer:61616. This will not give you a nice web page, but will give you data from the server. 
 
 If you are unable to connect to this address:
 - Double check that the ActiveMQ service is running
diff --git a/docs/doxygen-user/multi-user/installPostgres.dox b/docs/doxygen-user/multi-user/installPostgres.dox
index d56afe931b..07534da576 100644
--- a/docs/doxygen-user/multi-user/installPostgres.dox
+++ b/docs/doxygen-user/multi-user/installPostgres.dox
@@ -40,7 +40,7 @@ To install PostgreSQL, perform the following steps:
 <br><br>
 \image html newPassword.PNG
 <br><br>
-- Check <i>"Can create databases"</i> on the <i>"Role Privileges"</i> tab.
+- For <i>"Role Privileges"</i>, give the user <i>"Can Login?"</i> and <i>"Can create databases"</i>.
 <br><br>
 \image html newRights.PNG
 <br><br>
@@ -86,7 +86,7 @@ To this:
 Note the removal of the leading number symbol-this uncomments that entry.
 <br><br>
 
-4. Still in <i id="max_connections">"C:\Program Files\PostgreSQL\9.5\data\postgresql.conf"</i>, find the entry named _max_connections_ and set it to the number of suggested connections for your configuration. A rule of thumb is add 100 connections for each Automated Ingest Node and 100 connections for each Reviewer node you plan to have in the network.  See the screenshot below.
+4. Still in <i id="max_connections">"C:\Program Files\PostgreSQL\9.5\data\postgresql.conf"</i>, find the entry named _max_connections_ and set it to the number of suggested connections for your configuration. A rule of thumb is 100 connections per each Automated Ingest node and reviewer node. See the screenshot below.
 <br><br>
 \image html maxConnections.PNG
 <br><br>
@@ -98,6 +98,8 @@ Note the removal of the leading number symbol-this uncomments that entry.
 \image html postgresqlinstall7.PNG
 <br><br>
 
+6. Add the bin\\postgres.exe file to the Windows firewall to allow it to receive connections.
+
 
 \section install_post_test Testing
 
diff --git a/docs/doxygen-user/multi-user/installSolr.dox b/docs/doxygen-user/multi-user/installSolr.dox
index dd380e6eef..c2a25520c8 100644
--- a/docs/doxygen-user/multi-user/installSolr.dox
+++ b/docs/doxygen-user/multi-user/installSolr.dox
@@ -114,6 +114,10 @@ Start the "Solr_8.6.3" service, and verify that the service status changes to "R
 
 \image html solr_start_2.png
 
+\subsection install_solr_security AntiVirus Settings
+
+We have observed that Antivirus may detect strings in the Solr indexes as being malware.  You should add the Solr data directory to the exclusion list for your security product. We saw this with Windows Defender.
+
 \section install_solr_testing Testing
 
 There are two tests that you should perform to confirm that the Solr machine is configured correctly.