Installation Guide

Installation ⚙️

Standard Installation

1. Fork/Clone/Download this repo

   git clone https://github.com/Datalux/Osintgram.git

2. Navigate to the directory

   cd Osintgram

3. Create a virtual environment for this project

   python3 -m venv venv

4. Load the virtual environment

   • On Windows Powershell: .\venv\Scripts\activate.ps1
   • On Linux and Git Bash: source venv/bin/activate

5. Install dependencies

   pip install -r requirements.txt

6. Configure credentials

   Open the credentials.ini file in the config folder and write your Instagram account username and password in the corresponding fields. Or use hikerapi_token from https://hikerapi.com/tokens (first 100 requests are free after registration and confirmation of your tg)

   Alternatively, you can run the make setup command to populate this file for you.

7. Run the main.py script

   You can run it in one of three ways:

   • As an interactive prompt: python3 main.py <target username>
   • Execute your command straight away: python3 main.py <target username> --command <command>
   • Execute using HikerAPI token via env: HIKERAPI_TOKEN=<hikerapi token> python3 main.py <target username> -c <command>

Use Osintgram v2 (beta)

You can use Osintgram2 beta just switching to v2 branch. The v2 has some improvements and is faster with a new command execution interface. Try it just running:

git checkout v2

Docker Quick Start 🐳

Prerequisites

Before you can use either Docker or Docker-compose, please ensure you do have the following prerequisites met:

1. Docker installed - link
2. Docker-composed installed (if using Docker-compose) - link
3. Credentials configured - This can be done manually or by running the make setup command from the root of this repo

Important: Your container will fail if you do not do step #3 and configure your credentials

Docker

If docker is installed you can build an image and run this as a container.

Build:

docker build -t osintgram .

Run:

docker run --rm -it -v "$PWD/output:/home/osintgram/output" osintgram <target>

• The <target> is the Instagram account you wish to use as your target for recon.
• The required -i flag enables an interactive terminal to use commands within the container.
• The required -v flag mounts a volume between your local filesystem and the container to save to the ./output/ folder.
• The optional --rm flag removes the container filesystem on completion to prevent cruft build-up.
• The optional -t flag allocates a pseudo-TTY which allows colored output.

Using docker-compose

You can use the docker-compose.yml file this single command:

docker-compose run osintgram <target>

Where target is the Instagram target for recon.

Alternatively, you may run docker-compose with the Makefile:

make run  # Builds and Runs with compose. Prompts for a target before running.

Makefile (easy mode)

For ease of use with Docker-compose, a Makefile has been provided.

Here is a sample work flow to spin up a container and run osintgram with just two commands:

1. make setup - Sets up your Instagram credentials
2. make run - Builds and Runs a osintgram container and prompts for a target

Sample workflow for development:

1. make setup - Sets up your Instagram credentials
2. make build-run-testing - Builds an Runs a container without invoking the main.py script. Useful for an it Docker session for development
3. make cleanup-testing - Cleans up the testing container created from build-run-testing

Development version 💻

To use the development version with the latest feature and fixes just switch to development branch using Git:

git checkout development

and update to last version using:

git pull origin development

Updating ⬇️

To update Osintgram with the stable release just pull the latest commit using Git:

1. Make sure you are in the master branch: git checkout master
2. Download the latest version: git pull origin master