Getting started

Self hosted

Self hosted / on premises guide to deploy PentestPad

Warning!

On premises / self hosted instances are subject to approval by PentestPad. Request it at contact@pentestpad.com

Overview

PentestPad self hosted solution is based on containerized images that can be easily deployed over Docker or any other similar technology.

1. Pull the pentestpad-docker repository from Github

First, we need to pull the base configuration for deployment of the PentestPad instance.

git pull https://github.com/PentestPad/pentestpad-docker

2. Authenticate to the Docker Repository

Authentication is done using the credentials provided by the PentestPad team for your tenant.

docker login repository.pentestpad.com

3. Edit configuration

Inside the pentestpad-docker directory make a copy of .env.example into .env and edit configuration variables:

# Database configuration
DB_PASSWORD=secret

# License
LICENSE_KEY=

# Application URL
APP_URL=https://localhost
APP_HOSTNAME=localhost

# TEMP Admin user configuration, please delete from .env file after first login
ADMIN_NAME=Administrator
ADMIN_EMAIL=admin@localhost
ADMIN_PASSWORD=secret

# Mail configuration (mailgun, smtp)
MAIL_MAILER=smtp

# Mailgun configuration (optional, required if MAIL_MAILER=mailgun)
MAILGUN_DOMAIN=mg.domain.com
MAILGUN_SECRET="secret"

# SMTP configuration (optional, required if MAIL_MAILER=smtp)
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=username
MAIL_PASSWORD=password
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=support@pentestpad.com

4. Start the Docker container

It might take a few minutes to build the environment before the application becomes available at https://localhost:443

docker compose up