diff --git a/cloud/scanning/internal-scan.mdx b/cloud/scanning/internal-scan.mdx index 0d76e664..36ef983a 100644 --- a/cloud/scanning/internal-scan.mdx +++ b/cloud/scanning/internal-scan.mdx @@ -61,13 +61,13 @@ pd-agent is a lightweight agent that you deploy within your internal network to Before installing the agent, you need to create a network in the ProjectDiscovery's platform. Each network represents a distinct internal environment (e.g., production, staging, office network) and generates a unique agent configuration. -1. Navigate to [https://cloud.projectdiscovery.io/networks](https://cloud.projectdiscovery.io/networks) +1. Navigate to [https://cloud.projectdiscovery.io/internal-network](https://cloud.projectdiscovery.io/internal-network) 2. Click **"Create Network"** 3. Provide a network name 4. Save the network to generate your unique agent installation command - Creating a Network in PDCP + Creating a Network in PDCP @@ -78,20 +78,37 @@ Before installing the agent, you need to create a network in the ProjectDiscover After creating your network, the platform displays a ready-to-run installation command pre-configured with your `PDCP_API_KEY`, `PDCP_TEAM_ID`, and network name. Copy it and run it on a machine inside the network you want to scan. -The Docker command is the fastest way to get going — no prerequisites beyond Docker itself: - -```bash -docker run -d --name pd-agent \ - --network host --cap-add NET_RAW --cap-add NET_ADMIN \ - -e PDCP_API_KEY=your-api-key \ - -e PDCP_TEAM_ID=your-team-id \ - ghcr.io/projectdiscovery/pd-agent:latest \ - -agent-network your-network-name -``` - -- `--network host` lets the agent see your real network interfaces for subnet discovery. -- `NET_RAW` / `NET_ADMIN` enable naabu SYN scanning; drop them if you only need full-connect scans. -- `-agent-network` is the routing label scans are dispatched to — give each network a distinct name. + + + If you have Go installed, you can run the agent directly: + + ```bash + PDCP_API_KEY=your-api-key PDCP_TEAM_ID=your-team-id \ + go run github.com/projectdiscovery/pd-agent/cmd/pd-agent@main \ + -agent-network your-network-name + ``` + + - `PDCP_API_KEY` and `PDCP_TEAM_ID` are set as environment variables to authenticate with the platform. + - `-agent-network` is the routing label scans are dispatched to — give each network a distinct name. + + + + The Docker command is the fastest way to get going — no prerequisites beyond Docker itself: + + ```bash + docker run -d --name pd-agent \ + --network host --cap-add NET_RAW --cap-add NET_ADMIN \ + -e PDCP_API_KEY=your-api-key \ + -e PDCP_TEAM_ID=your-team-id \ + ghcr.io/projectdiscovery/pd-agent:latest \ + -agent-network your-network-name + ``` + + - `--network host` lets the agent see your real network interfaces for subnet discovery. + - `NET_RAW` / `NET_ADMIN` enable naabu SYN scanning; drop them if you only need full-connect scans. + - `-agent-network` is the routing label scans are dispatched to — give each network a distinct name. + + Keep your installation command secure - it contains your API key and agent configuration. Anyone with this command can connect an agent to your network. @@ -113,7 +130,7 @@ docker run -d --name pd-agent \ Once the agent runs successfully, it appears in your network dashboard along with the subnets it discovered on the host, indicating that it's ready to execute scans. - Complete pd-agent Setup: Create Network, Install Agent, and Verify Connection + Complete pd-agent Setup: Create Network, Install Agent, and Verify Connection ### Step 3: Discover Assets @@ -126,7 +143,7 @@ Before running vulnerability scans, you can discover assets in your internal net 4. Click on **Start Discovery** to initiate the discovery process. The pd-agent will scan your internal network and discovered assets will appear in your asset inventory - Discovering Assets in Internal Network using pd-agent + Discovering Assets in Internal Network using pd-agent @@ -143,7 +160,7 @@ Once your pd-agent is connected and assets are discovered (optional), you can tr 4. Click **Create Scan** to start - the agent runs the scan locally using its embedded toolset (nuclei, httpx, naabu, dnsx, tlsx) and streams results back to your dashboard - Creating and Running an Internal Scan in PDCP + Creating and Running an Internal Scan in PDCP diff --git a/images/internal_scan_create_network_demo.gif b/images/internal_scan_create_network_demo.gif new file mode 100644 index 00000000..dcce7acf Binary files /dev/null and b/images/internal_scan_create_network_demo.gif differ diff --git a/images/internal_scan_discovery_demo.gif b/images/internal_scan_discovery_demo.gif new file mode 100644 index 00000000..4014b05d Binary files /dev/null and b/images/internal_scan_discovery_demo.gif differ diff --git a/images/internal_scan_setup_demo.gif b/images/internal_scan_setup_demo.gif new file mode 100644 index 00000000..93af87bb Binary files /dev/null and b/images/internal_scan_setup_demo.gif differ diff --git a/images/internal_scan_vuln_scan_demo.gif b/images/internal_scan_vuln_scan_demo.gif new file mode 100644 index 00000000..189ed614 Binary files /dev/null and b/images/internal_scan_vuln_scan_demo.gif differ diff --git a/images/pd-agent-setup-demo.gif b/images/pd-agent-setup-demo.gif deleted file mode 100644 index 9ca40ef4..00000000 Binary files a/images/pd-agent-setup-demo.gif and /dev/null differ diff --git a/images/pdcp-create-network-demo.gif b/images/pdcp-create-network-demo.gif deleted file mode 100644 index e728d90c..00000000 Binary files a/images/pdcp-create-network-demo.gif and /dev/null differ diff --git a/images/pdcp-discover-assets-demo.gif b/images/pdcp-discover-assets-demo.gif deleted file mode 100644 index 74868a68..00000000 Binary files a/images/pdcp-discover-assets-demo.gif and /dev/null differ diff --git a/images/pdcp-internal-scan-demo.gif b/images/pdcp-internal-scan-demo.gif deleted file mode 100644 index 127e2424..00000000 Binary files a/images/pdcp-internal-scan-demo.gif and /dev/null differ