Quick Start

Prerequisites

Before starting, ensure you have the following installed on your system:

• Git
• Docker and Docker Compose (Recommended for the fastest setup)
• Python 3.8+ (If installing manually)

Quick Start with Docker

The fastest way to get Pulsar up and running is using Docker Compose. This handles all dependencies, including the Django backend, Vue.js frontend, Celery workers, and the necessary networking tools (Nmap, ZMap, etc.).

1. Clone the repository:

   git clone https://github.com/0x0FB0/pulsar.git
   cd pulsar
   

2. Configure Email (Optional): If you want email notifications, edit the EMAIL_BACKEND settings in portal/portal/settings.py before proceeding.

3. Launch the stack:

   docker-compose up -d
   

4. Create an administrative account:

   docker-compose exec web python manage.py createsuperuser
   

5. Access the Dashboard: Open your browser and navigate to http://localhost:8000. Log in with the credentials created in the previous step.

Manual Installation

If you prefer to install Pulsar directly on your host (Ubuntu/Debian recommended), use the provided installation script.

1. Clone and enter the directory:

   git clone https://github.com/0x0FB0/pulsar.git
   cd pulsar
   

2. Run the install script:

   chmod +x install.sh
   ./install.sh
   

3. Initialize the application:

   python3 manage.py migrate
   python3 manage.py createsuperuser
   

4. Start the services: You will need to start the Django server and the Celery worker in separate terminals:

   # Terminal 1: Web Server
   python3 manage.py runserver 0.0.0.0:8000
   
   # Terminal 2: Celery Worker (Required for scanning)
   celery -A portal worker -l info
   

Running Your First Scan

Once logged in, follow these steps to start discovery:

1. Create an Asset: Navigate to the Assets section and click "Add New Asset." Provide a name and a description for the organization or project.
2. Add a Scope: Inside the Asset, add your targets (e.g., example.com).
3. Launch Discovery:
   • Go to Scans.
   • Select your Asset.
   • Choose a Scan Policy (e.g., "Full Discovery").
   • Click Start Scan.
4. View Results: As the scan progresses, results will populate the Subdomains, IPv4, and Vulnerabilities tabs. You can visualize the infrastructure relationships in the Data Visualization module.

REST API Access

Pulsar includes a fully documented REST API for automation and integration.

• API Documentation: Accessible at /api/docs/ once the server is running.
• Authentication: Supports Basic Auth, Session Auth, and Token-based authentication.

Example Request (List Assets):

curl -X GET http://localhost:8000/api/assets/ \
     -H "Authorization: Token <your_api_token>"