Installation

Installation & Deployment

ReconSR installation is simple: download the archive for your platform, unpack it into the directory where you want to run the tool, and start the binary.

Official releases are available on the GitHub Releases page:

https://github.com/cdua-org/ReconSR/releases

Download the Correct Archive

Choose the archive that matches your operating system and CPU architecture.

Platform	Archive
Linux x86_64 / AMD64	ReconSR-linux-amd64.tar.gz
Linux ARM64	ReconSR-linux-arm64.tar.gz
macOS Apple Silicon	ReconSR-macos-apple-silicon.tar.gz
macOS Intel	ReconSR-macos-intel.tar.gz
Windows ARM64	ReconSR-windows-arm64.zip
Windows x64	ReconSR-windows-x64.zip

Unpack the Archive

Unpack the downloaded archive into the directory where you want to keep ReconSR.

The archive contains:

• ReconSR on Linux and macOS, or ReconSR.exe on Windows;
• LICENSE;
• README.md;
• third_party_licenses/, a directory containing third-party license information.

Example extracted layout on Linux or macOS:

ReconSR/
├── ReconSR
├── LICENSE
├── README.md
└── third_party_licenses/

Example extracted layout on Windows:

ReconSR\
├── ReconSR.exe
├── LICENSE
├── README.md
└── third_party_licenses\

Initial Configuration

The simplest path is to let ReconSR create default configuration files automatically. You can also prepare configuration files manually before the first run.

Note

Existing configuration files are read as-is. ReconSR does not overwrite existing configuration files with defaults after they have been created.

Use the following wiki pages when preparing or editing local configuration:

• Global Configuration for configs/config.txt;
• Scope Management for configs/scope.txt;
• Network Configuration for configs/network.txt;
• API Keys Configuration for configs/keys.txt;
• Offline Datasets for local database directories under data/.

Offline datasets are separate from the generated configuration files. If you want to use offline database modules, follow Offline Datasets to create the required data/ directories and place the database files before the first run.

Option 1: Let ReconSR Create Defaults

Start ReconSR once without creating configuration files manually. On first startup, ReconSR creates the default configuration directory and default configuration files when they are missing.

After the first startup:

1. Exit ReconSR.
2. Edit the generated configuration files if you want to change defaults.
3. Add API keys if required by the modules you want to use.
4. If you have not prepared offline datasets yet, create the required directories and add database files.
5. Start ReconSR again.

Option 2: Configure Before First Run

Before starting ReconSR, create the configs/ directory and add the configuration files you want to manage manually.

Use this option when you already know which global settings, scope rules, network settings, API keys, or offline databases you want to configure.