.. image:: https://github.com/mitre/thumbtack/actions/workflows/thumbtack_workflow.yml/badge.svg?branch=master
:target: https://github.com/mitre/thumbtack/actions
thumbtack
=========
Thumbtack is a web front-end providing a REST-ful API to mount and unmount
forensic disk images, built on top of the |imagemounter|_ library.
Documentation is available in the ``docs/`` directory or online at
https://thumbtack.readthedocs.io/en/latest.
Quick Start
-----------
.. code-block:: bash
$ 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 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
...
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
$ cd path/to/disk/image/files
$ sudo thumbtack
* Serving Flask app "thumbtack" (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* 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``.
Quick Reference
---------------
.. code-block:: bash
$ sudo thumbtack --help
Usage: thumbtack [OPTIONS]
Options:
-d, --debug Run the Thumbtack server in debug mode
-h, --host TEXT Host to run Thumbtack server on [default: 127.0.0.1]
-p, --port TEXT Port to run Thumbtack server on [default: 8208]
-m, --mount-dir TEXT Directory to mount disk images [Default: /mnt/thumbtack]
-i, --image-dir TEXT Directory of disk images for Thumbtack server to monitor [Default: $CWD]
--db TEXT SQLite database to store mount state
-b, --base-url TEXT Base URL where Thumbtack is hosted on the server [default: /]
--path-contains TEXT Only select files containing specified string in the path
-s, --skip-subdirectory TEXT Subdirectory to ignore when monitoring files
-r, --remove-directories Unmount all mountpoints and remove all empty directories in the thumbtack mount directory
--help Show this message and exit.
LICENSE
-------
Thumbtack is licensed under the `Apache License, Version 2.0
<https://www.apache.org/licenses/LICENSE-2.0.html>`_. See the `LICENSE` file for
more information.
RELEASE STATEMENT
-----------------
Approved for Public Release; Distribution Unlimited. Public Release Case Number 19-0358.
.. |imagemounter| replace:: ``imagemounter``
.. _imagemounter: https://imagemounter.readthedocs.io/en/latest/
Raw data
{
"_id": null,
"home_page": "https://github.com/mitre/thumbtack",
"name": "thumbtack",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4.0",
"maintainer_email": null,
"keywords": null,
"author": "The MITRE Corporation",
"author_email": "thumbtack@mitre.org",
"download_url": "https://files.pythonhosted.org/packages/3f/53/62c3cb450c26872f688a873c774125599a27239212088ce1e720095fdc34/thumbtack-0.5.3.tar.gz",
"platform": null,
"description": "\n.. image:: https://github.com/mitre/thumbtack/actions/workflows/thumbtack_workflow.yml/badge.svg?branch=master\n :target: https://github.com/mitre/thumbtack/actions\n\nthumbtack\n=========\n\nThumbtack is a web front-end providing a REST-ful API to mount and unmount\nforensic disk images, built on top of the |imagemounter|_ library.\n\nDocumentation is available in the ``docs/`` directory or online at\nhttps://thumbtack.readthedocs.io/en/latest.\n\nQuick Start\n-----------\n\n.. code-block:: bash\n\n $ sudo pip install thumbtack\n $ sudo imount --check # List install status of tools used by imagemounter\n The following commands are used by imagemounter internally. Without most commands, imagemounter works perfectly fine, but may lack some detection or mounting capabilities.\n -- Mounting base disk images (at least one required, first three recommended) --\n MISSING xmount needed for several types of disk images, part of the xmount package\n MISSING ewfmount needed for EWF images (partially covered by xmount), part of the ewf-tools package\n MISSING affuse needed for AFF images (partially covered by xmount), part of the afflib-tools package\n MISSING vmware-mount needed for VMWare disks\n MISSING mountavfs needed for compressed disk images, part of the avfs package\n MISSING qemu-nbd needed for Qcow2 images, part of the qemu-utils package\n ...\n\n\nInstall 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.\n\n\n.. code-block:: bash\n\n # Install tools\n $ sudo apt-get install xmount ewf-tools afflib-tools sleuthkit\n $ cd path/to/disk/image/files\n $ sudo thumbtack\n * Serving Flask app \"thumbtack\" (lazy loading)\n * Environment: production\n WARNING: This is a development server. Do not use it in a production deployment.\n Use a production WSGI server instead.\n * Debug mode: off\n * Running on http://127.0.0.1:8208/ (Press CTRL+C to quit)\n\n\nThen go to http://127.0.0.1:8208 and start mounting and unmounting images!\n\nFind a full tutorial in ``docs/tutorial.rst``.\n\nQuick Reference\n---------------\n\n.. code-block:: bash\n\n $ sudo thumbtack --help\n Usage: thumbtack [OPTIONS]\n\n Options:\n -d, --debug Run the Thumbtack server in debug mode\n -h, --host TEXT Host to run Thumbtack server on [default: 127.0.0.1]\n -p, --port TEXT Port to run Thumbtack server on [default: 8208]\n -m, --mount-dir TEXT Directory to mount disk images [Default: /mnt/thumbtack]\n -i, --image-dir TEXT Directory of disk images for Thumbtack server to monitor [Default: $CWD]\n --db TEXT SQLite database to store mount state\n -b, --base-url TEXT Base URL where Thumbtack is hosted on the server [default: /]\n --path-contains TEXT Only select files containing specified string in the path\n -s, --skip-subdirectory TEXT Subdirectory to ignore when monitoring files\n -r, --remove-directories Unmount all mountpoints and remove all empty directories in the thumbtack mount directory\n --help Show this message and exit.\n\nLICENSE\n-------\n\nThumbtack is licensed under the `Apache License, Version 2.0\n<https://www.apache.org/licenses/LICENSE-2.0.html>`_. See the `LICENSE` file for\nmore information.\n\nRELEASE STATEMENT\n-----------------\nApproved for Public Release; Distribution Unlimited. Public Release Case Number 19-0358.\n\n\n.. |imagemounter| replace:: ``imagemounter``\n.. _imagemounter: https://imagemounter.readthedocs.io/en/latest/\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Service to manage disk image mounts.",
"version": "0.5.3",
"project_urls": {
"Homepage": "https://github.com/mitre/thumbtack"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d65dbd9c3448c4ce69248171620b71c6670218574fd2e21b73f17cb6b70d4ace",
"md5": "08cd99b134e04f3b4f2048ea3e5faa9f",
"sha256": "029faf7248e8fe78ab017a3d2e7a14f4ca0f69dfc4cdf5c60f5d66095dacfb1b"
},
"downloads": -1,
"filename": "thumbtack-0.5.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "08cd99b134e04f3b4f2048ea3e5faa9f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.4.0",
"size": 24900,
"upload_time": "2024-10-01T18:40:32",
"upload_time_iso_8601": "2024-10-01T18:40:32.205689Z",
"url": "https://files.pythonhosted.org/packages/d6/5d/bd9c3448c4ce69248171620b71c6670218574fd2e21b73f17cb6b70d4ace/thumbtack-0.5.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f5362c3cb450c26872f688a873c774125599a27239212088ce1e720095fdc34",
"md5": "9598c561e94e405c883fb982235773b7",
"sha256": "db1ea8483ced7de9925056e849383a85081e5fce4648d64e4cb92e4b3961dd3d"
},
"downloads": -1,
"filename": "thumbtack-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "9598c561e94e405c883fb982235773b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4.0",
"size": 24022,
"upload_time": "2024-10-01T18:40:33",
"upload_time_iso_8601": "2024-10-01T18:40:33.630832Z",
"url": "https://files.pythonhosted.org/packages/3f/53/62c3cb450c26872f688a873c774125599a27239212088ce1e720095fdc34/thumbtack-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 18:40:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mitre",
"github_project": "thumbtack",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "thumbtack"
}
JSON
