diff --git a/docs/doxygen-user/central_repo.dox b/docs/doxygen-user/central_repo.dox index 03b45b6040..5583971bfc 100644 --- a/docs/doxygen-user/central_repo.dox +++ b/docs/doxygen-user/central_repo.dox @@ -38,7 +38,7 @@ Once a database has been configured, the lower two buttons on the main panel wil Setting up PostgreSQL Deployment -If needed, see the \ref install_postgresql for help setting up your PostgreSQL server. +If needed, see the \ref install_postgresql_page for help setting up your PostgreSQL server. For PostgreSQL all values are required, but some defaults are provided for convenience. @@ -221,4 +221,4 @@ then contain each instance of that notable phone number. -*/ \ No newline at end of file +*/ diff --git a/docs/doxygen-user/multi-user/installActiveMQ.dox b/docs/doxygen-user/multi-user/installActiveMQ.dox index fd0726e1b1..8a0d9405a2 100644 --- a/docs/doxygen-user/multi-user/installActiveMQ.dox +++ b/docs/doxygen-user/multi-user/installActiveMQ.dox @@ -1,4 +1,4 @@ -/*! \page install_activemq Install and Configure ActiveMQ +/*! \page install_activemq_page Install and Configure ActiveMQ \section install_activemq_overview Overview diff --git a/docs/doxygen-user/multi-user/installMultiUser.dox b/docs/doxygen-user/multi-user/installMultiUser.dox index 7a67bd6ade..a70d2b5deb 100644 --- a/docs/doxygen-user/multi-user/installMultiUser.dox +++ b/docs/doxygen-user/multi-user/installMultiUser.dox @@ -16,25 +16,20 @@ Each Autopsy client will then use those shared resources instead of the embedded \section multiuser_install_install Cluster Installation and Configuration -Let's now step through the process of setting up an Autopsy cluster. +Let's now step through the process of setting up an Autopsy cluster. When you setup the network services, write down the addresses, user names, and passwords for each so that you can more easily configure each of the client systems afterwards. -Step 1: \ref multiuser_system +Step 1: \ref install_multiuser_systems_page -Step 2: \ref multiuser_users +Step 2: \ref install_multiuseruser_page -Step 3: \ref multiuser_storage +Step 3: \ref install_multiuser_storage_page -Step 4: \ref install_postgresql +Step 4: \ref install_postgresql_page -Step 5: \ref install_solr +Step 5: \ref install_solr_page -Step 6: \ref install_activemq - -Step 7: \ref multiuser_install_clients - - - -When you setup the above services, write down the addresses, user names, and passwords or each so that you can configure each of the client systems afterwards. +Step 6: \ref install_activemq_page +Step 7: \ref install_multiuserclient_page */ diff --git a/docs/doxygen-user/multi-user/installMultiUserClient.dox b/docs/doxygen-user/multi-user/installMultiUserClient.dox index d0f3fdeb6a..171875e4a3 100644 --- a/docs/doxygen-user/multi-user/installMultiUserClient.dox +++ b/docs/doxygen-user/multi-user/installMultiUserClient.dox @@ -1,7 +1,7 @@ -/*! \page install_multiuserclient_page Setting Up Multi-user Client +/*! \page install_multiuserclient_page Install Autopsy Clients -\section multiuser_install_clients Install Autopsy Clients +\section multiuser_install_clients Overview Once the infrastructure is in place, you can configure Autopsy clients to use them. - Install Autopsy on each client system. Use the normal installer and pick the defaults. diff --git a/docs/doxygen-user/multi-user/installPostgres.dox b/docs/doxygen-user/multi-user/installPostgres.dox index 1f089c781b..0164a1fd1a 100644 --- a/docs/doxygen-user/multi-user/installPostgres.dox +++ b/docs/doxygen-user/multi-user/installPostgres.dox @@ -1,4 +1,4 @@ -/*! \page install_postgresql Install and Configure PostgreSQL +/*! \page install_postgresql_page Install and Configure PostgreSQL \section install_post_over Overview diff --git a/docs/doxygen-user/multi-user/installSharedStorage.dox b/docs/doxygen-user/multi-user/installSharedStorage.dox index 3152ed3ab0..6651d6ab69 100644 --- a/docs/doxygen-user/multi-user/installSharedStorage.dox +++ b/docs/doxygen-user/multi-user/installSharedStorage.dox @@ -1,6 +1,6 @@ -/*! \page install_multiuser_storage_page Setting Up Shared Storage +/*! \page install_multiuser_storage_page Set Up Shared Storage -\section multiuser_storage Set Up Shared Storage +\section multiuser_storage Overview The cluster will need shared storage that can be accessed from: - Autopsy clients diff --git a/docs/doxygen-user/multi-user/installSolr.dox b/docs/doxygen-user/multi-user/installSolr.dox index 6070fc65e1..c5ffa052bd 100644 --- a/docs/doxygen-user/multi-user/installSolr.dox +++ b/docs/doxygen-user/multi-user/installSolr.dox @@ -1,4 +1,4 @@ -/*! \page install_solr Install and Configure Solr +/*! \page install_solr_page Install and Configure Solr \section install_solr_overview Overview @@ -15,12 +15,8 @@ We use Bitnami Solr, which packages Solr as a Windows service. You will need: - A 64-bit version of the Java Runtime Environment (JRE) from http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html. - The Apache Solr 4.10.3-0 installation package. This is no longer available from its original source, but you can find it on our site: https://sourceforge.net/projects/autopsy/files/CollaborativeServices/Solr. +-- NOTE: We tested Solr 6 at one point, but ran into stability problems when loading and unloading cores. For now, you need to use Solr 4. - An installed version of Autopsy so that you can copy files from it. You can install Autopsy on one of the planned client systems. You do not need to install it on the Solr server. - - - - - - A network-accessible machine to install Solr on. Note that the Solr process will need to write data out to the main shared storage drive, and needs adequate permissions to write to this location, which may be across a network. diff --git a/docs/doxygen-user/multi-user/installSystems.dox b/docs/doxygen-user/multi-user/installSystems.dox index 400ecd6dd3..e171539245 100644 --- a/docs/doxygen-user/multi-user/installSystems.dox +++ b/docs/doxygen-user/multi-user/installSystems.dox @@ -1,6 +1,6 @@ -/*! \page install_multiuser_systems_page Multi-user Hardware / VM Selection +/*! \page install_multiuser_systems_page Pick Your Hardware / VM Configuration -\section multiuser_system Pick Your Hardware / VM Configuration +\section multiuser_system Overview The first step in setting up a multi-user cluster is picking how many computers or VMs you'll use to run the various services. @@ -10,14 +10,19 @@ From a service perspective, you'll need to run: - ActiveMQ messaging server - Network storage -You can run each of these on their own dedicated VM, but that is not necessary. We recommend: +You can run each of these on their own dedicated VM, but that is not necessary. + +Apache Solr uses a lot of memory, so we recommend keeping it by itself. The exception is if you are using Windows File Sharing for shared storage. You can get better Solr performance if it is writing to local storage instead of over the network. So, you can consider using the same computer for both Solr and shared storage. + +Also note that because all computers need to access the shared storage at the same path, you cannot mix operating systems. A Linux system running Solr will not be able to access the shared storage at the same path as a Windows Autopsy client. + + + +We recommend: - Server 1: PostgreSQL and ActiveMQ - Both of these are low overhead services. - Server 2: Apache Solr and Shared Storage (if you are using Windows File Sharing). - - Apache Solr uses a lot of memory, so we keep it by itself. - - The benefit of running the shared storage on the same computer as Solr is performance. Solr is much faster when it can write to local storage instead of over the network. - - If you are using a different form of shared storage, then we still recommend keeping Solr on its own. \subsection multiuser_system_hw Suggested Hardware diff --git a/docs/doxygen-user/multi-user/installUsers.dox b/docs/doxygen-user/multi-user/installUsers.dox index 1b29230258..53a556ece8 100644 --- a/docs/doxygen-user/multi-user/installUsers.dox +++ b/docs/doxygen-user/multi-user/installUsers.dox @@ -1,6 +1,6 @@ -/*! \page install_multiuseruser_page Picking Users +/*! \page install_multiuseruser_page Pick Your User Accounts -\section multiuser_users Pick Your User Accounts +\section multiuser_users Overview Before you get into configuring any computers, you should have an understanding about what user accounts will be used. User account permissions are one of the most common challenges people have when setting up a cluster.