Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/sepinf-inc/IPED/llms.txt

Use this file to discover all available pages before exploring further.

​
Processing Settings

IPED’s main configuration file is IPEDConfig.txt, located in the iped-app/resources/config/ directory. This file controls all processing features and settings.

​
Hash Calculation

OptionTypeDefaultDescription
enableHashbooleantrueEnables file hashes calculation (MD5, SHA-1, SHA-256, SHA-512, eDonkey)
enablePhotoDNAbooleanfalseEnables PhotoDNA hash calculation (law enforcement only)
enableHashDBLookupbooleanfalseEnables hash lookup on IPED database
enablePhotoDNALookupbooleanfalseEnables PhotoDNA lookup on IPED hash database

​
Content Detection and Analysis

OptionTypeDefaultDescription
enableLedDiebooleanfalseEnables nudity detection with scoring (1-1000) and classification (1-5)
enableYahooNSFWDetectionbooleanfalseEnables Yahoo OpenNSFW deep learning algorithm for nudity detection
enableCSAMDetectorbooleanfalseDetects Child Sexual Abuse Material using TensorFlow, PyTorch or ONNX AI model
enableQRCodebooleanfalseEnables QR code detection and decoding
enableLanguageDetectbooleantrueDetects more than 70 languages in document files
enableNamedEntityRecognitonbooleanfalseRecognizes named entities: people, organizations, places (requires Stanford CoreNLP)
enableFaceRecognitionbooleanfalseEnables face recognition feature (requires Python dependencies)
enableAgeEstimationbooleanfalseEnables age estimation feature (requires Python dependencies)

​
File Processing

OptionTypeDefaultDescription
processFileSignaturesbooleantrueProcesses file signatures
enableFileParsingbooleantrueEnables parsing of file contents (required for many features)
expandContainersbooleantrueExpands containers like compressed files, emails, and Office documents
processEmbeddedDisksbooleantrueProcesses disk images (DD, E01, VHD, VMDK) recursively
ignoreDuplicatesbooleanfalseIgnores duplicated files with same hash (WARNING: potentially dangerous)
exportFilePropsbooleantrueExports file properties to “Lista de Arquivos.csv”

​
Search and Indexing

OptionTypeDefaultDescription
enableRegexSearchbooleantrueSearches texts for social numbers, emails, URLs, credit cards, crypto addresses, etc.
indexFileContentsbooleantrueIndexes file contents; if disabled, only file properties are indexed
entropyTestbooleantrueTests for randomness to detect encrypted items
enableIndexToElasticSearchbooleanfalseEnables indexing to ElasticSearch/OpenSearch cluster
enableGraphGenerationbooleantrueCreates link graphs of communications (calls, messages, emails)

​
OCR and Transcription

OptionTypeDefaultDescription
enableOCRbooleanfalseEnables OCR on images and scanned PDFs (increases processing time significantly)
enableAudioTranscriptionbooleanfalseEnables audio transcription (VOSK, Wav2Vec2, Whisper, Azure, Google Cloud)

​
Carving

OptionTypeDefaultDescription
enableCarvingbooleanfalseEnables carving (requires addUnallocated enabled)
enableLedCarvingbooleanfalseRetrieves known files from LED base using file beginning (requires addUnallocated)
enableKnownMetCarvingbooleanfalseCarves eMule “known.met” files (requires addUnallocated)

​
Thumbnails and Media Processing

OptionTypeDefaultDescription
enableImageThumbsbooleantrueGenerates image thumbnails during processing
enableImageSimilaritybooleanfalseEnables search for visually similar images (requires enableImageThumbs)
enableVideoThumbsbooleantrueExtracts image frames from video files
enableDocThumbsbooleanfalseCreates thumbnails for PDFs and LibreOffice formats (experimental)

​
Export and Storage

OptionTypeDefaultDescription
enableAutomaticExportFilesbooleanfalseEnables automatic file export based on categories or keywords
enableMinIObooleanfalseEnables exporting files to MinIO object storage cluster
enableHTMLReportbooleantrueEnables HTML report generation

​
Special Features

OptionTypeDefaultDescription
enableSearchHardwareWalletsbooleantrueEnables searching for crypto hardware wallets
enableRemoteImageClassifierbooleanfalsePerforms classification of image and video files using remote service

​
Configuration File Locations

IPED uses a hierarchical configuration system:

​
Advanced Configuration Files

Each processing task may have its own configuration file in the conf/ directory:
  • AudioTranscriptConfig.txt - Audio transcription settings
  • OCRConfig.txt - OCR language and quality settings
  • CSAMDetectorConfig.txt - CSAM detection model configuration
  • FaceRecognitionConfig.txt - Face recognition parameters
  • AgeEstimationConfig.txt - Age estimation settings
  • VideoThumbsConfig.txt - Video frame extraction settings
  • RegexConfig.txt - Regular expression patterns
  • CarverConfig.xml - File carving configuration
  • HashTaskConfig.txt - Hash algorithm selection
  • MinIOConfig.txt - MinIO object storage settings
  • ElasticSearchConfig.txt - ElasticSearch/OpenSearch settings

​
Performance Tuning

Key performance settings are found in LocalConfig.txt:
  • numThreads: Set to “default” or specify number of processing threads
  • indexTempOnSSD: Enable if temp directory is on SSD (can improve speed up to 2x)
  • outputOnSSD: Enable if output folder is on SSD
  • indexTemp: Location of temporary processing directory

​
Best Practices

Critical Configuration Warnings:
  1. ignoreDuplicates: Setting this to true is dangerous as it may exclude duplicated files with different metadata (names, paths, dates)
  2. enableCSAMDetector/enablePhotoDNA: These features require proper legal authorization and proprietary models
  3. enableOCR/enableAudioTranscription: These significantly increase processing time and resource usage
  4. Temp Directory: Configure on a folder free of antivirus scanning and system indexing, preferably on SSD

Build docs developers (and LLMs) love

Get started for freeTalk to us