diff --git a/docs/doxygen-user/images/multiuser_settings.PNG b/docs/doxygen-user/images/multiuser_settings.PNG deleted file mode 100644 index 0226c07662..0000000000 Binary files a/docs/doxygen-user/images/multiuser_settings.PNG and /dev/null differ diff --git a/docs/doxygen-user/images/solr/solr_adding_nodes_1.png b/docs/doxygen-user/images/solr/solr_adding_nodes_1.png new file mode 100644 index 0000000000..72eda5b3eb Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_adding_nodes_1.png differ diff --git a/docs/doxygen-user/images/solr/solr_adding_nodes_2.png b/docs/doxygen-user/images/solr/solr_adding_nodes_2.png new file mode 100644 index 0000000000..f93324681d Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_adding_nodes_2.png differ diff --git a/docs/doxygen-user/images/solr/solr_autopsy.png b/docs/doxygen-user/images/solr/solr_autopsy.png new file mode 100644 index 0000000000..06aea11831 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_autopsy.png differ diff --git a/docs/doxygen-user/images/solr/solr_autopsy_zk.png b/docs/doxygen-user/images/solr/solr_autopsy_zk.png new file mode 100644 index 0000000000..53e61c17c1 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_autopsy_zk.png differ diff --git a/docs/doxygen-user/images/solr/solr_config_case.png b/docs/doxygen-user/images/solr/solr_config_case.png new file mode 100644 index 0000000000..b2e73468be Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_config_case.png differ diff --git a/docs/doxygen-user/images/solr/solr_config_folder.png b/docs/doxygen-user/images/solr/solr_config_folder.png new file mode 100644 index 0000000000..615e0903d5 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_config_folder.png differ diff --git a/docs/doxygen-user/images/solr/solr_config_param.png b/docs/doxygen-user/images/solr/solr_config_param.png new file mode 100644 index 0000000000..dbc81d0cb1 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_config_param.png differ diff --git a/docs/doxygen-user/images/solr/solr_config_todo.png b/docs/doxygen-user/images/solr/solr_config_todo.png new file mode 100644 index 0000000000..01c587dfff Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_config_todo.png differ diff --git a/docs/doxygen-user/images/solr/solr_install_1.png b/docs/doxygen-user/images/solr/solr_install_1.png new file mode 100644 index 0000000000..17b9359d69 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_install_1.png differ diff --git a/docs/doxygen-user/images/solr/solr_install_2.png b/docs/doxygen-user/images/solr/solr_install_2.png new file mode 100644 index 0000000000..fe2a9516ef Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_install_2.png differ diff --git a/docs/doxygen-user/images/solr/solr_install_3.png b/docs/doxygen-user/images/solr/solr_install_3.png new file mode 100644 index 0000000000..571312d5a5 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_install_3.png differ diff --git a/docs/doxygen-user/images/solr/solr_install_4.png b/docs/doxygen-user/images/solr/solr_install_4.png new file mode 100644 index 0000000000..6ff5fa8bcd Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_install_4.png differ diff --git a/docs/doxygen-user/images/solr/solr_running_in_parallel.png b/docs/doxygen-user/images/solr/solr_running_in_parallel.png new file mode 100644 index 0000000000..53e61c17c1 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_running_in_parallel.png differ diff --git a/docs/doxygen-user/images/solr/solr_standalone_zk_1.png b/docs/doxygen-user/images/solr/solr_standalone_zk_1.png new file mode 100644 index 0000000000..8ac44025e9 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_standalone_zk_1.png differ diff --git a/docs/doxygen-user/images/solr/solr_standalone_zk_2.png b/docs/doxygen-user/images/solr/solr_standalone_zk_2.png new file mode 100644 index 0000000000..ab64dcb392 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_standalone_zk_2.png differ diff --git a/docs/doxygen-user/images/solr/solr_standalone_zk_3.png b/docs/doxygen-user/images/solr/solr_standalone_zk_3.png new file mode 100644 index 0000000000..937a871f31 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_standalone_zk_3.png differ diff --git a/docs/doxygen-user/images/solr/solr_standalone_zk_4.png b/docs/doxygen-user/images/solr/solr_standalone_zk_4.png new file mode 100644 index 0000000000..744b478d69 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_standalone_zk_4.png differ diff --git a/docs/doxygen-user/images/solr/solr_start_1.png b/docs/doxygen-user/images/solr/solr_start_1.png new file mode 100644 index 0000000000..c17bb02a86 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_start_1.png differ diff --git a/docs/doxygen-user/images/solr/solr_start_2.png b/docs/doxygen-user/images/solr/solr_start_2.png new file mode 100644 index 0000000000..28a3825e46 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_start_2.png differ diff --git a/docs/doxygen-user/images/solr/solr_testing_1.png b/docs/doxygen-user/images/solr/solr_testing_1.png new file mode 100644 index 0000000000..6157dadf67 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_testing_1.png differ diff --git a/docs/doxygen-user/images/solr/solr_user_1.png b/docs/doxygen-user/images/solr/solr_user_1.png new file mode 100644 index 0000000000..31bbc855e3 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_user_1.png differ diff --git a/docs/doxygen-user/images/solr/solr_user_2.png b/docs/doxygen-user/images/solr/solr_user_2.png new file mode 100644 index 0000000000..8849a5e082 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_user_2.png differ diff --git a/docs/doxygen-user/images/solr/solr_zk_migration_1.png b/docs/doxygen-user/images/solr/solr_zk_migration_1.png new file mode 100644 index 0000000000..d85ba4e992 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_zk_migration_1.png differ diff --git a/docs/doxygen-user/images/solr/solr_zk_migration_2.png b/docs/doxygen-user/images/solr/solr_zk_migration_2.png new file mode 100644 index 0000000000..9f8afbe3e4 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_zk_migration_2.png differ diff --git a/docs/doxygen-user/images/solr/solr_zk_migration_3.png b/docs/doxygen-user/images/solr/solr_zk_migration_3.png new file mode 100644 index 0000000000..ec329b6dc2 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_zk_migration_3.png differ diff --git a/docs/doxygen-user/images/solr/solr_zk_migration_4.png b/docs/doxygen-user/images/solr/solr_zk_migration_4.png new file mode 100644 index 0000000000..f2e67a5503 Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_zk_migration_4.png differ diff --git a/docs/doxygen-user/images/solr/solr_zk_migration_5.png b/docs/doxygen-user/images/solr/solr_zk_migration_5.png new file mode 100644 index 0000000000..51dca488ce Binary files /dev/null and b/docs/doxygen-user/images/solr/solr_zk_migration_5.png differ diff --git a/docs/doxygen-user/multi-user/installMultiUserClient.dox b/docs/doxygen-user/multi-user/installMultiUserClient.dox index 171875e4a3..2dd385f1df 100644 --- a/docs/doxygen-user/multi-user/installMultiUserClient.dox +++ b/docs/doxygen-user/multi-user/installMultiUserClient.dox @@ -3,20 +3,19 @@ \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. -- Test that the user has access to the shared storage by opening the shared storage folders using Windows Explorer. If a password prompt is given, then enter the password and store the credentials (see \ref multiuser_users_store). -- Start Autopsy and open the multi-user settings panel from "Tools", "Options", "Multi-user". As shown in the screenshot below, you can then enter all of the address and authentication information for the network-based services. Note that in order to create or open Multi-user cases, "Enable Multi-user cases" must be checked and the settings below must be correct. - -\image html multiuser_settings.PNG - -- For each setting, press the "Test" button to ensure that Autopsy can communicate with each service. If any fail, then refer to the specific setup page for testing options. Also check that a firewall is not blocking the communications. - - - NOTE: None of these tests are for permissions on the shared storage because Autopsy does not know about the shared storage. It can't test that until you make a case. - -- Make a test case (see \ref creating_multi_user_cases). You can add a single file in as a logical data source. The key concept is to look for errors. - - If you find errors, look for errors in the log file on the Autopsy client. - - If you followed all of the previous steps in all of the previous pages, then a common error at this point is that Solr cannot access the shared storage and it is running as a Service account. When this happens, you'll see an error message about Solr not being able to create or access a "core". If this happens, review what user Solr should be running as (see \ref multiuser_users_solr) and change the shared storage configuration or ensure that credentials are stored. +Once the infrastructure is in place, you can configure Autopsy clients to use them. +
    +
  1. Install Autopsy on each client system. Use the normal installer and pick the defaults. +
  2. Test that the user has access to the shared storage by opening the shared storage folders using Windows Explorer. If a password prompt is given, then enter the password and store the credentials (see \ref multiuser_users_store). +
  3. Start Autopsy and open the multi-user settings panel from "Tools", "Options", "Multi-user". As shown in the screenshot below, you can then enter all of the address and authentication information for the network-based services. Note that in order to create or open Multi-user cases, "Enable Multi-user cases" must be checked and the settings below must be correct. +\image html solr_autopsy.png +
  4. For each setting, press the "Test Connection" button to ensure that Autopsy can communicate with each service. If any fail, then refer to the specific setup page for testing options. Also check that a firewall is not blocking the communications. + +
  5. Make a test case (see \ref creating_multi_user_cases). You can add a single file in as a logical data source. The key concept is to look for errors. + +
*/ \ No newline at end of file diff --git a/docs/doxygen-user/multi-user/installSolr.dox b/docs/doxygen-user/multi-user/installSolr.dox index 1c3970e344..71559ed104 100644 --- a/docs/doxygen-user/multi-user/installSolr.dox +++ b/docs/doxygen-user/multi-user/installSolr.dox @@ -1,149 +1,211 @@ /*! \page install_solr_page Install and Configure Solr +[TOC] + \section install_solr_overview Overview +Autopsy uses Apache Solr to store keyword text indexes. A central server is needed in a multi-user cluster to maintain and search the indexes. -Autopsy uses Apache Solr to store keyword text indexes. A central server is needed in a multi-user cluster to maintain and search the indexes. +A new text index is created for each case. The index can be stored either on shared storage or on the local drive of the Solr server(s) (large amount of local storage is required). -A new text index is created for each case and is stored in the case folder on shared storage (not on the local drive of the Solr server). +Solr's embedded ZooKeeper is also used as a coordination service for Autopsy. -Solr's embedded ZooKeeper is also used as a coordination service for Autopsy. +If you have already installed Solr 4 with a previous version of Autopsy, please see the \ref upgrade_solr_page page for information on how open older cases after the upgrade and migrate data. \section install_solr_prereq Prerequisites -We use Bitnami Solr, which packages Solr as a Windows service. +We have prepared a pre-packaged version of Solr which packages Solr as Windows service. You will need: -- A 64-bit version of the Java 8 Runtime Environment (JRE) from https://github.com/ojdkbuild/ojdkbuild. ( Link to installer) -- 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. - - +