Skip to content

configuration.md

Latest commit

 

History

History
82 lines (63 loc) · 3.86 KB

configuration.md

File metadata and controls

82 lines (63 loc) · 3.86 KB
Raw

Configuration reference

Generate a complete file with:

python3 -B run.py --init-config recovery.json

Relative output_directory values in a JSON file are resolved from the directory containing that file. Command-line options override JSON values.

Device and case settings

Field Default Purpose
adb_path adb ADB executable path or command name.
serial null Device serial. Automatic selection requires exactly one authorized device.
output_directory Current directory Parent directory for generated cases.
case_prefix cases- Prefix used for automatic case numbering.
case_width 2 Minimum numeric width, such as 01.
case_name null Exact directory name instead of automatic numbering.
user_id 0 Android user used in MediaStore commands.
storage_roots [] Explicit shared-storage roots. Empty enables discovery.
include_removable_storage true Include readable /storage/XXXX-XXXX volumes during discovery.

An exact case_name must not already exist. Valid explicit roots are /sdcard and /storage/XXXX-XXXX.

Timeouts and limits

Field Default Purpose
command_timeout 120 General ADB timeout in seconds.
query_timeout 300 MediaStore query timeout in seconds.
scan_timeout 1800 Remote filesystem discovery timeout in seconds.
transfer_timeout 3600 Timeout for one streamed file.
max_cache_record_mib 128 Largest accepted BlobCache record.
max_trash_candidates 0 Maximum candidates to acquire. Zero is unlimited.
max_preview_candidates 0 Maximum previews to export. Zero is unlimited.
thumbnail_batch_size 100 Classic thumbnails read per tar stream.

Recovery stages

Field Default Purpose
acquire_trash true Run Trash discovery and acquisition.
mediastore_trash true Query rows where is_trashed=1.
filesystem_trash true Search shared storage for Trash containers.
trash_artifacts true Capture Trash databases and marker files.
recover_previews true Build the MediaStore index and inspect caches.
gallery_cache true Parse Gallery2-style BlobCache sources.
classic_thumbnails true Inspect ID-named thumbnail files.
thumbdata true Inspect legacy .thumbdata containers.

Thumbdata layout

Field Default Purpose
thumbdata_slot_size 10000 Expected bytes per slot.
thumbdata_slot_count 5000 Slot count used for MediaStore ID correlation.
thumbdata_header_tolerance 64 Maximum image offset within a slot.

These values describe a common Android thumbnail layout. Change them only when a known device format has been verified.

Provider and vendor adapters

Field Default Purpose
mediastore_uri content://media/external/file?includeTrashed=1 Collection queried and read through MediaStore.
media_columns Standard seven columns Projection used for correlation and Trash metadata.
gallery_cache_bases Known Gallery cache paths Direct paths checked when traversal is restricted.
trash_directory_names Known Trash names Exact directory names added to generic discovery.

media_columns must retain _id, _data, _display_name, is_trashed, and _size.

Output behavior

Field Default Purpose
fail_on_stage_error true Return a failure status after a recoverable stage error.
log_level INFO DEBUG, INFO, WARNING, or ERROR.
banner true Display the startup banner.

Safety restrictions are not configurable. The tool always requires UID 2000, performs no root fallback, uses no UI automation, and writes no data to the Android device.