Skip to main content

Quick Start

This walkthrough covers the default flow in main.go, which is used for local testing.

Running a Scan​

  1. Make sure your Mullvad VPN is connected.
  2. Edit the urls slice in main.go with the open directory URLs you want to scan.
  3. Run the binary:
go run .

odirscan performs two passes:

  1. Scan -- Crawls each URL, validates it as an open directory listing (by checking that the HTML <title> matches the first <h1>), and recursively follows subdirectory links. Files are filtered by MIME type and directory keywords.
  2. Tag -- Performs HTTP HEAD requests on every discovered file URL to collect metadata: content type, content length, last modified date, and scan time.

Results are cached to findings.json so subsequent runs skip the scan phase.

Viewing Results​

After scanning completes, a web server starts on port 8080:

INFO Serving results addr=http://localhost:8080

Open http://localhost:8080 in your browser to see the results table.

Cache​

Delete findings.json to force a fresh scan:

rm findings.json
go run .