Difference between revisions of "Autopsy Developer's Guide"

From SleuthKitWiki
Jump to: navigation, search
Line 17: Line 17:
 
* To compile the program from source, refer to [http://github.com/sleuthkit/autopsy/blob/master/BUILDING.txt BUILDING.txt].
 
* To compile the program from source, refer to [http://github.com/sleuthkit/autopsy/blob/master/BUILDING.txt BUILDING.txt].
 
* [[Autopsy 3 Design]] doc is a reference on developing additional features / bug fixes.
 
* [[Autopsy 3 Design]] doc is a reference on developing additional features / bug fixes.
 +
* [[Developing Autopsy 3 Ingest Modules]] is a reference for integrating in your analysis functionality into Autopsy.
 +
* [[Developing Autopsy 3 Content Viewers]] is a reference for adding different windows to view file content.
 +
* [[Developing Autopsy 3 Report Modules]] is a reference for building custom report generation modules.
 
* [[Autopsy 3 Logging and Error Checking]] is a reference for how errors and log messages are made.
 
* [[Autopsy 3 Logging and Error Checking]] is a reference for how errors and log messages are made.

Revision as of 13:55, 6 June 2012

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.

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: