Autopsy Developer's Guide
This page contains technical information on developing code for Autopsy.
General sleuthkit.org Information
This page is a work in progress and more information will be posted. Here are some starting points.
- The Developer Guidelines define how code and patches can be submitted and incorporated into the sleuthkit.org projects.
- The sleuthkit-developers list exists to discuss the development of the sleuthkit.org tools. Subscribe to ask and answer questions.
- If you want to contribute documentation, then refer to the Support page.
What To Do?
If you are looking for ideas on how you can contribute, then you may want to refer to the feature request and bug trackers. They contain ideas that people have for the tools or bugs that need to be fixed.
If you have an idea for an Autopsy feature, you can create a new Autopsy module. See the developer guide for information on writing modules, and look at the current list of Autopsy 3rd Party Modules.
Source Code
The source code is stored in a github repository. You can get the latest source tree from http://github.com/sleuthkit/autopsy. The latest code is in the master branch. There is a branch for minor releases and tags for each release. The github repository contains the history from the previous subversion repository. Note that the previous subversion repository was created right before the 2.20 release and does not contain the previous CVS history.
Autopsy 3.0
Autopsy 3 is a complete rewrite from Autopsy 2. This section will cover the topics that developers need to get started. This section will be better organized as we add content, but here are some starting points:
- To compile the program from source, refer to BUILDING.txt.
- Developer's Guide contains the API docs and information on how to write modules.
- Autopsy 3 Logging and Error Checking is a reference for how errors and log messages are made.
- Autopsy 3 Module Versions is a reference on the versioning scheme of the internal modules.