Skip to content

AmadeusITGroup/pwndoc1A

 
 

Repository files navigation

Pwndoc1A

Vue.js Badge Quasar Badge Node.js Badge MongoDB Badge Docker Badge

PwnDoc1A (a fork of Pwndoc) is a penetration testing reporting application designed to streamline the process of documenting findings and generating customizable Docx reports. It features easy findings creation, knowledge sharing, statistics, and report generation capabilities to further enhance efficiency.

Installation Guide

Prerequisites

  • Git installed
  • Docker and Docker Compose available
  • jq command-line JSON processor
  • Bash shell

Installation Steps

1. Clone the Repository

git clone https://github.com/AmadeusITGroup/pwndoc1A.git
cd pwndoc1A

2. Install jq

Depending on your operating system:

Ubuntu/Debian

sudo apt-get update sudo apt-get install jq

macOS (using Homebrew)

brew install jq

CentOS/RHEL

sudo yum install jq

3. Run Installation Script

./install.sh

4. Script Functionality

The install.sh script performs several critical setup tasks:

  • Cryptographic Key Generation
    • Generates encryption keys for database security
    • Creates secure, unique cryptographic mechanisms
  • Authentication Configuration
    • Configures Single Sign-On (SSO) authentication
    • Provides option to enable or disable SSO based on your infrastructure needs
  • Database Initialization
    • Prepares and populates the database
    • Sets up initial data structures and configurations
  • Container Deployment
    • Uses Docker Compose to deploy necessary containers
    • Ensures consistent environment across different systems

5. Post-Installation Verification

After running the script, verify:

  • Containers are running correctly
  • Database is populated
  • Authentication mechanisms are functioning

Troubleshooting

If you encounter issues during installation:

  • Check script permissions (chmod +x install.sh)
  • Verify all dependencies are installed
  • Confirm jq is properly installed
  • Review logs for specific error messages

You can also open an GitHub so that I can help you.

Documentation

Features

  • Multiple Language support
  • Multiple Data support
  • Great Customization
    • Manage reusable Audit and Vulnerability Data
    • Create Custom Sections
    • Add custom fields to Vulnerabilities
  • Vulnerabilities Management
  • Multi-User reporting
  • Docx Report Generation
  • Docx Template customization
  • Statistics (WIP)

Demos

Donate

If you would like to help me and sponsor this project

❤️ Sponsor Me

Thank you for the support !