OSINT Meta Scanner

Pre-requisites

• Python
• Poetry
• Node.js
• Docker
• Docker Compose
• just

  [!NOTE] We use just as a task runner. It automatically loads the .env file and sets the environment variables.

• direnv (optional)

Scanner Images

• theHarvester

  docker build -t theharvester https://github.com/laramies/theHarvester.git

• Amass

  docker pull caffix/amass

• BBOT

  docker pull blacklanternsecurity/bbot

Development

1. Install dependencies

   poetry install

2. Start the PostgreSQL database and Redis server

   docker compose -f compose.dev.yaml up -d

3. Copy the .env.example file to .env and fill in the required values
4. Run the migrations

   just alembic upgrade head

5. Run the application server

   just server

6. Run the Celery worker

   just celery worker --loglevel=INFO

7. Change directory into the client app and run its development server:

   cd client/
   npm run dev

Deployment

Use the included compose.yaml file as an example deployment configuration.

1. Start the services

   docker compose up -d

2. Run the migrations

    docker compose exec app alembic upgrade head

3. Access the application at http://localhost:8080