mirror of
https://github.com/aaru-dps/Aaru.Documentation.git
synced 2025-12-16 11:14:32 +00:00
Add initial docsify setup
Signed-off-by: Jonas Rosland <jrosland@vmware.com>
This commit is contained in:
36
5.3/Quickstart.md
Normal file
36
5.3/Quickstart.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Quickstart
|
||||
|
||||
## How to Dump a Disk Image
|
||||
It’s very easy to dump any supported media quickly with Aaru! You just have to run `aaru media dump <drive> <output image>` for the most basic options. If you dump to something that’s not Aaru Image Format (images with the extensions .aaruformat, .aaruf, and .aif), you will also have to add the “-f” option at the end of the command.
|
||||
|
||||
### Examples (Windows):
|
||||
|
||||
`aaru media dump E: Image.aaruf`
|
||||
|
||||
`aaru media dump F: Image.iso -f`
|
||||
|
||||
### Examples (Linux):
|
||||
|
||||
`aaru media dump /dev/sr0 Image.aaruf`
|
||||
|
||||
`aaru media dump /dev/sr1 Image.iso -f`
|
||||
|
||||
## Comparing Between Two Media Dumps
|
||||
Comparing between media dumps using Aaru is simple! All you have to do is run the command `aaru image compare image-1 image-2`. Neither of the dumps being compared have to be created by Aaru, they can be any of the supported formats from any software.
|
||||
|
||||
### Examples (All OS’):
|
||||
|
||||
`aaru image compare Image1.aaruf Image2.cue`
|
||||
|
||||
`aaru image compare Image1.iso Image2.ccd`
|
||||
|
||||
## Analysing a Media Dump
|
||||
WIP
|
||||
|
||||
## Extracting Content From a Media Dump
|
||||
Aaru can extract the files from any supported media dump, as long as it uses a supported filesystem to store its files. The command for this is “aaru filesystem extract *Image* *Output folder*”. You can also add “-x” to the end of the command to extract the more technical extended attributes from an image as well.
|
||||
|
||||
### Examples:
|
||||
`aaru filesystem extract Image.aaruf Output`
|
||||
|
||||
`aaru filesystem extract Image.ccd Output -x`
|
||||
35
README.md
Normal file
35
README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Aaru Data Preservation Suite
|
||||
|
||||
Hello! **Aaru Data Preservation Suite** is a fully-featured software package to preserve all storage media from the very old to the cutting edge, as well as to give detailed information about any supported image file (whether from Aaru or not) and to extract the files from those images.
|
||||
|
||||
## Aaru DPS includes:
|
||||
- **Aaru**
|
||||
- The main software that does all the heavy lifting, including dumping and extraction.
|
||||
- **Aaru Remote**
|
||||
- A slim application that allows Aaru to dump media or run other commands on an unsupported system via a network connection.
|
||||
- **Libaaruformat**
|
||||
- C implementation of the Aaru Image Format.
|
||||
- And more!
|
||||
|
||||
## Key features of Aaru:
|
||||
|
||||
- Aaru Image Format, the format that stores the most amount of data for any given format, and supports media of almost any type.
|
||||
- Dumps almost any kind of storage media, with more types of media being added whenever possible.
|
||||
- Able to read information and extract files from many different formats, as well as easily convert from any format to many other compatible formats.
|
||||
- Automatically stores metadata, including checksums, of the image files and their tracks (if applicable) in an easily accessible XML, and can generate this data for any image.
|
||||
|
||||
## Key features of the Aaru Image Format:
|
||||
- Stores the most amount of data compared to any other image format for supported media.
|
||||
- Uses compression to take up the least space possible compared to any other format.
|
||||
- Can be used to store data from any type of media supported by Aaru.
|
||||
- Can be converted to many formats supported by Aaru, so you can easily create an ISO (or other image types) for software that doesn’t support the Aaru Image Format.
|
||||
|
||||
## Installation
|
||||
|
||||
Download the latest release from https://github.com/aaru-dps/Aaru/releases
|
||||
|
||||
For a practical UI for Aaru, we recommend using the [Media Preservation Frontend](https://github.com/SabreTools/MPF).
|
||||
|
||||
## Quickstart
|
||||
|
||||
See the [Quickstart](5.3/Quickstart.md) section of the docs!
|
||||
1
_Footer.md
Normal file
1
_Footer.md
Normal file
@@ -0,0 +1 @@
|
||||
Aaru © 2011-2020 Natalia Portillo
|
||||
8
_coverpage.md
Normal file
8
_coverpage.md
Normal file
@@ -0,0 +1,8 @@
|
||||

|
||||
|
||||
# Aaru Data Preservation Suite
|
||||
|
||||
> A fully featured media dump management solution
|
||||
|
||||
[GitHub](https://github.com/aaru-dps/aaru/)
|
||||
[Getting Started](#aaru-data-preservation-suite)
|
||||
48
_sidebar.md
Normal file
48
_sidebar.md
Normal file
@@ -0,0 +1,48 @@
|
||||
- Getting started
|
||||
- [Quickstart](5.3/Quickstart.md)
|
||||
- [Creating a media dump](Creating-a-dump-from-physical-media.md)
|
||||
- [Analyzing a media dump](Analyzing-a-media-dump.md)
|
||||
- [Comparing two media dumps](Comparing-two-media-dumps.md)
|
||||
- [Extracting files from a media dump](Extracting-files-from-a-media-dump.md)
|
||||
- [Calculate hashes and checksums](Getting-hashes-and-checksums-from-a-media-dump.md)
|
||||
|
||||
- Configuration
|
||||
|
||||
- [Configure statistics](Configure-Aaru-statistics.md)
|
||||
|
||||
- Detection
|
||||
|
||||
- [Check readability of the media](Check-readability-of-the-media-inserted-in-a-physical-device.md)
|
||||
|
||||
- Analysis
|
||||
|
||||
- [Creating metadata sidecar](Creating-metadata-sidecar-XML.md)
|
||||
- [Decoding and printing media tags](Decoding-and-printing-media-tags.md)
|
||||
- [Supported media tags](Media-tags.md)
|
||||
- [Hexadecimal print of a media dump](Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md)
|
||||
- [Calculate dump contents entropy](Calculate-dump-contents-entropy.md)
|
||||
- [Get info about a media dump](Getting-information-from-a-media-dump.md)
|
||||
- [Get info about a physical device](Getting-information-from-a-physical-device.md)
|
||||
- [Get info about a inserted media](Getting-information-from-media-inserted-in-a-physical-device.md)
|
||||
|
||||
- Conversion
|
||||
|
||||
- [Convert a media dump](Convert-image.md)
|
||||
|
||||
- Listing
|
||||
|
||||
- [List files](List-files.md)
|
||||
- [List filesystem options](List-filesystem-options.md)
|
||||
- [List image options](List-image-options.md)
|
||||
- [List supported devices](List-supported-devices.md)
|
||||
- [List supported encodings](List-supported-encodings.md)
|
||||
- [List supported formats](List-supported-formats.md)
|
||||
- [List supported namespaces](List-supported-namespaces.md)
|
||||
|
||||
- FAQ
|
||||
|
||||
- [Filesystems recognized by Aaru](Filesystems-recognized-by-Aaru.md)
|
||||
- [Media dump formats supported by Aaru](Media-dump-formats-supported-by-Aaru.md)
|
||||
- [Comparing Aaru with other solutions](Comparison.md)
|
||||
- [Bugs in other dumping software](Bugs-in-other-dumping-software.md)
|
||||
- [More FAQ](FAQ.md)
|
||||
BIN
assets/.DS_Store
vendored
Normal file
BIN
assets/.DS_Store
vendored
Normal file
Binary file not shown.
BIN
assets/img/.DS_Store
vendored
Normal file
BIN
assets/img/.DS_Store
vendored
Normal file
Binary file not shown.
BIN
assets/img/aaru.png
Normal file
BIN
assets/img/aaru.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 587 KiB |
3
assets/img/github.svg
Normal file
3
assets/img/github.svg
Normal file
@@ -0,0 +1,3 @@
|
||||
<svg width="1024" height="1024" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z" transform="scale(64)" fill="#1B1F23"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 967 B |
33
index.html
Normal file
33
index.html
Normal file
@@ -0,0 +1,33 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Aaru Data Preservation Suite</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||||
<meta name="description" content="Description">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
||||
<!-- Theme: Simple Dark -->
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
|
||||
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.3/css/all.css" integrity="sha384-SZXxX4whJ79/gErwcOYf+zWLeJdY/qpuqC4cAa9rOGUstPomtqpuNWT9wdPEn2fk" crossorigin="anonymous">
|
||||
</head>
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script>
|
||||
window.$docsify = {
|
||||
coverpage: true,
|
||||
loadSidebar: true,
|
||||
subMaxLevel: 2,
|
||||
name: 'Aaru',
|
||||
repo: '',
|
||||
themeable: {
|
||||
readyTransition : true, // default
|
||||
responsiveTables: true // default
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<!-- Docsify v4 -->
|
||||
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
|
||||
<!-- docsify-themeable (latest v0.x.x) -->
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user