# 🖥 Installation

## Docker Installation (Recommended)

#### Docker installation

Get [Docker](https://docs.docker.com/get-docker/) for Windows, Linux and MacOS

**Where to get Docker Compose**

**Windows and macOS**

Docker Compose is included in [Docker Desktop](https://www.docker.com/products/docker-desktop) for Windows and macOS.

#### Linux

You can download Docker Compose binaries from the [release page](https://github.com/docker/compose/releases) on this repository.

Run OSIF with docker and docker-compose

<pre><code>git clone https://github.com/fr4nc1stein/osint-framework osif
cd osif
<strong>docker-compose up -d
</strong>docker exec -ti osif bash
./osif
</code></pre>

If not started, follow this instruction below:

```
docker build --no-cache  --tag osif .
docker run -ti osif bash
./osif
```

## Manual Installation

Recommended on Linux or Kali

Install Dependencies:

```
sudo apt-get update && \
    apt-get -y install gcc mono-mcs 

sudo apt-get update && apt-get install git build-essential -y
sudo apt-get install libmagic1 -y
```

Fork the Repo

```
git clone https://github.com/fr4nc1stein/osint-framework osif
cd osif
pip3 install -r requirements
```

## Configuration

Create .env

1. Virustotal API <https://www.virustotal.com/>
2. CENSYS API <https://accounts.censys.io/> (not working - still fixing)
3. ABUSECH <https://bazaar.abuse.ch/> (not required)
4. SHODAN API <https://account.shodan.io/>
5. HUNTER API <https://hunter.io/api-keys>
6. BITCOINABUSE API <https://www.bitcoinabuse.com/>
7. WIGLE API <https://wigle.net/> (geolocation module)

```
VT_API=""
CENSYS_APPID=""
CENSYS_SECRET=""
ABUSECH_API_KEY = ""
SHODAN_API_KEY = ""
HUNTER_API_KEY = ""
BITCOINABUSE_API_KEY = ""
WIGLE_API_NAME = ""
WIGLE_API_TOKEN = ""
```

```
─$ ./osif


                                                         ##     ####   #####   ######
                                                        #  #   #    #    #     #
                                                       #    #  #         #     #
                                                       #    #   ####     #     ####
                                                       #    #       #    #     #
                                                        #  #   #    #    #     #
                                                         ##     ####   #####   #

            
                                                             >> OSINT Framework                                                            
                                                                 >> @laet4x                                                                
                                                                                                                                           
 

        -=[ 2 attack-surface ]=-
        -=[ 3 blockchain     ]=-
        -=[ 1 email          ]=-
        -=[ 4 host_enum      ]=-
        -=[ 2 ioc            ]=-
        -=[ 1 social         ]=-
        -=[ 1 web_enum       ]=-

[!] There are some issues ; use 'show issues' to see more details
osif > use host_enum/dns_records    
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://osif.laet4x.com/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.