Skip to content

mswell/burnrecon

Repository files navigation

BurnRecon

Licence Python MongoDB Docker


Description

BurnRecon is a tool to automate and organize reconnaissance operations.

Built with ❤️ and:


VPS Credit

If you need a VPS and are signing up for a new Digital Ocean account, please use my link!

DigitalOcean Referral Badge

Instalation

Run with docker: recommended 🍺

TODO: change docker-compose to docker compose

git clone https://github.com/mswell/burnrecon.git
docker-compose up -d

If run without docker

Requirement: python 3.7 or higher

git clone https://github.com/mswell/burnrecon.git
cd burnrecon
./install_hacktools.sh
pip3 install -r requirements.txt

Requirement: docker and docker-compose

If you use a local instance mongodb, use docker-compose to start your local mongoDB.

docker-compose up -d mongo

Settings

If you use docker-compose to run burnrecon, your settings for DB connection are in the file docker-compose.yml,

version: '3.1'

services:
  app:
    build:
      context: .
      dockerfile: Dockerfile
    stdin_open: true
    tty: true
    depends_on:
      - mongo
    environment:
      DYNACONF_MONGO_INITDB_ROOT_USERNAME: 'root'
      DYNACONF_MONGO_INITDB_ROOT_PASSWORD: 'toor'
      DYNACONF_MONGO_DB_ADDRESS: 'mongo'
    networks:
      - backend

For tokens I recommended to use .secrets.yml.

You need to set your config in settings file.

[database]
address = 'localhost'

You need to set your secrets in the secrets file.

MONGO_DB_USER = 'root'
MONGO_DB_PASS = 'toor'
DISCORD_TOKEN = ''

Please remember to mv .secrets_example.toml to .secrets.toml


Usage

To use local cli see cli wiki

To use docker see docker wiki

Development

Read the CONTRIBUTING.md file.