From a660f6301f7e84c199774f754d757e02a37bbe5e Mon Sep 17 00:00:00 2001 From: Austin Gibbons Date: Mon, 12 Feb 2024 14:44:59 -0500 Subject: [PATCH 1/4] Update readme. --- README.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 9459306..cadc4ce 100644 --- a/README.rst +++ b/README.rst @@ -15,9 +15,26 @@ Quick Start .. code-block:: bash - $ pip install thumbtack + $ sudo pip install thumbtack + $ sudo imount --check # List install status of tools used by imagemounter + The following commands are used by imagemounter internally. Without most commands, imagemounter works perfectly fine, but may lack some detection or mounting capabilities. + -- Mounting base disk images (at least one required, first three recommended) -- + MISSING xmount + MISSING ewfmount + MISSING affuse + MISSING vmware-mount needed for VMWare disks + MISSING mountavfs needed for compressed disk images, part of the avfs package + MISSING qemu-nbd needed for Qcow2 images, part of the qemu-utils package + ... + + +Install additional tools needed to mount your images. More information can be found in the imagemounter docs https://github.com/mitre/thumbtack.git. + +.. code-block:: bash + # Install tools + $ sudo apt-get install xmount ewf-tools afflib-tools sleuthkit $ cd path/to/disk/image/files - $ thumbtack + $ sudo thumbtack * Serving Flask app "thumbtack" (lazy loading) * Environment: production WARNING: This is a development server. Do not use it in a production deployment. From 13d89ff915b01918c474669d050d0a6c69d62adc Mon Sep 17 00:00:00 2001 From: Austin Gibbons Date: Mon, 12 Feb 2024 14:46:41 -0500 Subject: [PATCH 2/4] Fix installation link. --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index cadc4ce..7a5df24 100644 --- a/README.rst +++ b/README.rst @@ -19,16 +19,16 @@ Quick Start $ sudo imount --check # List install status of tools used by imagemounter The following commands are used by imagemounter internally. Without most commands, imagemounter works perfectly fine, but may lack some detection or mounting capabilities. -- Mounting base disk images (at least one required, first three recommended) -- - MISSING xmount - MISSING ewfmount - MISSING affuse + MISSING xmount + MISSING ewfmount + MISSING affuse MISSING vmware-mount needed for VMWare disks MISSING mountavfs needed for compressed disk images, part of the avfs package MISSING qemu-nbd needed for Qcow2 images, part of the qemu-utils package ... -Install additional tools needed to mount your images. More information can be found in the imagemounter docs https://github.com/mitre/thumbtack.git. +Install additional tools needed to mount your images. More information can be found in the imagemounter installation docs https://imagemounter.readthedocs.io/en/latest/installation.html. .. code-block:: bash # Install tools From ff45a51eaf085215a5eeb24e3b7e6b44033459dc Mon Sep 17 00:00:00 2001 From: Austin Gibbons Date: Mon, 12 Feb 2024 14:50:19 -0500 Subject: [PATCH 3/4] Update commands in readme. --- README.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 7a5df24..8b231a2 100644 --- a/README.rst +++ b/README.rst @@ -19,9 +19,9 @@ Quick Start $ sudo imount --check # List install status of tools used by imagemounter The following commands are used by imagemounter internally. Without most commands, imagemounter works perfectly fine, but may lack some detection or mounting capabilities. -- Mounting base disk images (at least one required, first three recommended) -- - MISSING xmount - MISSING ewfmount - MISSING affuse + MISSING xmount needed for several types of disk images, part of the xmount package + MISSING ewfmount needed for EWF images (partially covered by xmount), part of the ewf-tools package + MISSING affuse needed for AFF images (partially covered by xmount), part of the afflib-tools package MISSING vmware-mount needed for VMWare disks MISSING mountavfs needed for compressed disk images, part of the avfs package MISSING qemu-nbd needed for Qcow2 images, part of the qemu-utils package @@ -30,6 +30,7 @@ Quick Start Install additional tools needed to mount your images. More information can be found in the imagemounter installation docs https://imagemounter.readthedocs.io/en/latest/installation.html. + .. code-block:: bash # Install tools $ sudo apt-get install xmount ewf-tools afflib-tools sleuthkit @@ -42,6 +43,7 @@ Install additional tools needed to mount your images. More information can be fo * Debug mode: off * Running on http://127.0.0.1:8208/ (Press CTRL+C to quit) + Then go to http://127.0.0.1:8208 and start mounting and unmounting images! Find a full tutorial in ``docs/tutorial.rst``. @@ -51,7 +53,7 @@ Quick Reference .. code-block:: bash - $ thumbtack --help + $ sudo thumbtack --help Usage: thumbtack [OPTIONS] Options: From aadf69600569b90d06506674c7a2499bf37adcb4 Mon Sep 17 00:00:00 2001 From: Austin Gibbons Date: Mon, 12 Feb 2024 14:51:04 -0500 Subject: [PATCH 4/4] Update code block format --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index 8b231a2..4e032cb 100644 --- a/README.rst +++ b/README.rst @@ -32,6 +32,7 @@ Install additional tools needed to mount your images. More information can be fo .. code-block:: bash + # Install tools $ sudo apt-get install xmount ewf-tools afflib-tools sleuthkit $ cd path/to/disk/image/files