0. Installation Guide

Installation Guide

This guide covers how to install reconFTW on various platforms, including local systems (PC/VPS/VM), Docker, and AWS via Terraform/Ansible. Ensure you have at least 10 GB of free disk space and a stable internet connection.

Local Installation (PC/VPS/VM)

Prerequisites

• Operating System: Linux (Ubuntu/Debian recommended), macOS, or ARM-based systems (e.g., Raspberry Pi, macOS M1/M2).
• Golang: Version 1.15.0 or higher (automatically installed by default).
• System Permissions: Root access or sudo privileges configured to avoid prompts:

  sudo echo "${USERNAME} ALL=(ALL:ALL) NOPASSWD: ALL" | sudo tee -a /etc/sudoers.d/reconFTW

• Dependencies: git, curl, wget, python3, pip, and make.

Installation Steps

1. Clone the repository:

   git clone https://github.com/six2dez/reconftw
   cd reconftw

2. Run the installer:

   ./install.sh

3. Verify installation:

   ./reconftw.sh -h

Notes

• The install.sh script installs Golang, Rust, and required tools, and configures paths (GOROOT, GOPATH, PATH).
• If Golang is already installed, set install_golang=false in reconftw.cfg.
• For ARM systems, ensure Golang and Rust are compiled for your architecture (e.g., arm64 for macOS M1/M2).
• Common issues:
  • Golang path errors: Verify GOROOT and GOPATH in reconftw.cfg.
  • Permission denied: Ensure sudo is configured or run as root.

Docker Installation

Steps

1. Pull the official image:

   docker pull six2dez/reconftw:main

2. Run the container:

   docker run -it --rm -v "${PWD}/OutputFolder/:/reconftw/Recon/" six2dez/reconftw:main -d example.com -r

3. View results in the OutputFolder directory on the host.

Customization

• Modify Behavior: Edit the Docker image or build your own using the provided Dockerfile.
• Axiom Integration: Extend the image for Axiom Controller support.
• Troubleshooting:
  • Ensure Docker has write permissions for OutputFolder.
  • Check container logs for tool installation errors.

Notes

• Results are not stored in the container; always mount a host directory.
• See the Docker Usage Guide for advanced configurations.

Terraform + Ansible Deployment

Prerequisites

• AWS account with configured credentials.
• Terraform and Ansible installed.
• SSH key pair for AWS EC2 instances.

Steps

1. Navigate to the Terraform directory:

   cd reconftw/Terraform

2. Initialize Terraform:

   terraform init

3. Apply the configuration:

   terraform apply

4. Follow the Ansible playbook instructions in Terraform/README.md.

Notes

• This deploys reconFTW on AWS EC2 instances with preconfigured tools.
• Customize the Terraform variables for instance type, region, etc.
• Ensure your AWS credentials have sufficient permissions.

Post-Installation

After installation, configure API keys and tools in reconftw.cfg. See the Post-Installation Guide for details.

Troubleshooting

• Tool installation fails: Run ./install.sh with DEBUG_STD="" in reconftw.cfg to view logs.
• Network issues: Verify internet connectivity and DNS resolution.
• ARM-specific issues: Ensure GOARCH=arm64 for ARM systems.

For further help, join our Discord server or Telegram group.