Installation & Local Setup

While the OSINT Framework is available online at osintframework.com, you can also run it locally. This is particularly useful if you want to contribute to the project or use a customized version of the framework.

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Node.js and npm: The project uses npm to manage development dependencies. You can download them from nodejs.org.
  • Python: The project's start script uses Python's built-in simple web server. Most Unix-like systems (Linux, macOS) have Python pre-installed. For Windows, you can download it from python.org.
  • Git: To clone the repository.

Setup Instructions

Follow these steps to get the OSINT Framework running on your local machine.

1. Clone the Repository

Open your terminal and clone the GitHub repository:

git clone https://github.com/lockfale/OSINT-Framework.git

2. Navigate to the Project Directory

cd OSINT-Framework-master

3. Install Dependencies

The project uses a postinstall script defined in package.json to copy the required D3.js library into the public/js/vendor directory. Run the following command to install the necessary dependencies and trigger this script:

npm install

This command will install copyfiles and d3 as development dependencies from package.json.

4. Start the Local Server

The project includes a convenient start script that launches a simple Python web server to serve the application files.

npm start

This command executes cd ./public; python -m SimpleHTTPServer 8000. You should see output in your terminal indicating that the server is running, similar to this:

Serving HTTP on 0.0.0.0 port 8000 ...

5. Access the Framework

Open your web browser and navigate to:

http://localhost:8000

You should now see the interactive OSINT Framework running locally.