Merge pull request #6338 from APriestman/6813_configDocs

6813 Add page on general options.
This commit is contained in:
Richard Cordovano 2020-09-24 18:54:38 -04:00 committed by GitHub
commit 3f4a4a15fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 60 additions and 7 deletions

View File

@ -0,0 +1,54 @@
/*! \page config_page General Configuration
[TOC]
\section config_overview Overview
You can configure Autopsy through the main options panel. This is accessed by going to Tools->Options. Here you can change how cases are displayed, configure how Autopsy runs, and create hash sets, keyword lists, etc.
The options panel has different tabs for each feature. These options are documented on the main pages for each feature. For example, the \ref keyword_search_configuration_dialog "keyword search options panel" is described on the main \ref keyword_search_page page. The tabs that do not go with a feature documented elsewhere will be described here.
\section config_app Application Options
The first tab on the options panel is for general application settings.
\image html options_application.png
The top section lets you adjust how much memory is used by Autopsy and how many log files to keep. Generally each Autopsy session generates one log file, though it can generate more if the log file becomes too large.
The next section lets you specify where Autopsy should store temporary files. These files will be deleted when a case is closed.
The final section lets you set a custom logo.
\image html options_logo.png
This logo will be displayed in any generated \ref report_html "HTML reports".
\image html options_logo_report.jpg
\section config_view View Options
See the \ref view_options_page page for a description of how you can customize what data is displayed in Autopsy.
\section config_ext_viewer External Viewers
The External Viewers tab allows you to add file associations and select a hex editor.
\image html options_ext_viewer.jpg
The top section allows you to enter custom file associations by either extension or MIME type. In the image above we've associated .xml files with the Notepad application. Now it is possible to right click on a .xml file in the results viewer and choose "Open in external viewer" to open that .xml file in Notepad.
\image html options_ext_viewer_context_menu.jpg
The bottom section allows you to specify a hex editor. HxD has been tested and is the default, but other hex editors will work as well. The selected hex editor will be launched when clicking the "Launch in HxD" button in the "Hex" tab of the \ref content_viewer_page.
\section config_general General Options
The general options tab allows you to configure proxy settings.
\image html proxySettings.PNG
*/

View File

@ -14,9 +14,7 @@ The Hex tab is nearly always available and shows you the raw and exact contents
\image html content_viewer_hex.png
If desired, you can open the file in an external hex editor. This is configured through the "External Viewer" tab on the options panel. HxD has been verified to work with Autopsy, but alternate hex editors may also be compatible.
\image html content_viewer_hex_editor_setup.png
If desired, you can open the file in an external hex editor. This is configured through the \ref config_ext_viewer tab on the options panel. HxD has been verified to work with Autopsy, but alternate hex editors may also be compatible.
Note that this process saves the file to disk before launching the hex editor. A progress indicator will be displayed in the lower right corner of the application. If you wish to cancel the file export, click the 'X' to the right of the progress bar.

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

View File

@ -12,13 +12,14 @@ Help Topics
-------
The following topics are available here:
- Installation
- \subpage installation_page
- \subpage performance_page
- \subpage installation_page
- Configuration
- \subpage config_page
- \subpage performance_page
- Multi-user Cluster
- \subpage install_multiuser_page
- \subpage multiuser_sec_page
- \subpage multiuser_page
- \subpage multiuser_page
- \subpage quick_start_guide "Quick Start Guide"