Skip to content

Installation Guide

Jump to bottom
Mohammadreza Sarayloo edited this page May 17, 2022 · 20 revisions

You have two options to run this web application.

1. Run Dockerized version of the Web-App (easy to use):

$ git clone https://github.com/signorrayan/RedTeam_toolkit.git && cd RedTeam_toolkit
$ docker-compose -f docker-compose.yml up -d --build && docker-compose -f docker-compose.yml exec webapp python manage.py createsuperuser
# Create your local user and webapp will be available on --------> 127.0.0.1:4334

2. Manual Configuration on Ubuntu/Debian (from scratch)

Currently only tested on Debian/Ubuntu. If you have tested in any other distribution and all the tools run smoothly, to add the distribution to this guide,
please refer to the contributing section.

  • Install Required packages:

$ sudo add-apt-repository ppa:longsleep/golang-backports
$ sudo apt update
    && sudo apt install python3-pip python3-venv python3-django golang-go postgresql postgresql-contrib nmap git openvpn freerdp2-x11 tigervnc-viewer 
$ git clone https://github.com/signorrayan/RedTeam_toolkit.git && cd RedTeam_toolkit
$ go install github.com/lc/gau/v2/cmd/gau@latest \
    && go install github.com/tomnomnom/waybackurls@latest\
    && go install github.com/tomnomnom/qsreplace@latest\
    && go install github.com/takshal/freq@latest
    && cp /home/$(whoami)/go/bin/{gau,waybackurls,freq,qsreplace} ./toolkit/scripts/webapp/

  • Set-up Postgresql DB for django:

(set-up your password or you can set-up your new user & role):

sudo passwd postgres

login and create a new user and the database:

$ sudo -u postgres psql


postgres=# CREATE DATABASE redteam_toolkit_db;
postgres=# CREATE ROLE redteamuser with SUPERUSER CREATEDB LOGIN ENCRYPTED PASSWORD '147r258r'; -- we use this password in django settings.py, if you want to use another password, change the password in the settings.py too, both should be the same. 
postgres=# GRANT ALL PRIVILEGES ON DATABASE redteam_toolkit_db TO redteamuser;
postgres=# ALTER DATABASE redteam_toolkit_db OWNER TO redteamuser;
postgres=# \q
  • put your SECRET_KEY in a new file .env (you can generate the key in the online sources, search: Django Secret Key Generator) . Here is where to create the file:
RedTeam_toolkit/
├─ Demo/
├─ RedTeam_toolkit/
├─ toolkit/
├─ manage.py
├─ .env

# .env file content:

SECRET_KEY='Your Secret Key'
SQL_HOST=localhost
ALLOWED_HOSTS=localhost,127.0.0.1
SQL_DATABASE=redteam_toolkit_db
SQL_USER=redteamuser
SQL_PASSWORD=147r258r
DATABASE=postgres

  • active venv and Install the python packages:

$ python3 -m venv venv
$ source venv/bin/activate
$ pip3 install -r requirements.txt

  • Database migration:

python manage.py makemigrations
python manage.py migrate

  • Create a superuser to manage admin page :

you will need this user to login in the Web-UI

python manage.py createsuperuser

  • Start the project :

python manage.py runserver

  • You can access that via:

127.0.0.1:8000

and you can login with your superuser or create a new user through: http://127.0.0.1:8000/sherlockholmes admin page.
Enter your superuser information and in the management page, you can add a new user.

login and start using that.
if you have any question about the Installation, ask me in the issues section.

Please check Additional Information Page for more information about modules.

Clone this wiki locally