Repository files navigation

TunnelX is a lightweight ingress tunneling tool designed to create a secure SOCKS5 proxy server for routing network traffic. TunnelX is created for enabling internal network scanning from theProjectDiscovery platform, ensuring a seamless and isolated connection.

• Secure network ingress via SOCKS5 proxy.
• Authenticated connections using yourProjectDiscovery API key.
• Isolated traffic routing for internal scanning and discovery.

TunnelX creates secure ingress tunnels using your ProjectDiscovery API key, enabling isolated internal scanning via a SOCKS5 proxy.

You can run TunnelX on different networks by specifying unique network names. This allows you to scan multiple networks independently, with each connection appearing as a selectable option in the network dropdown menu on theProjectDiscovery Scans page.

1. Run the Docker image:

   docker run --network host -d -e PDCP_API_KEY="your_api_key" projectdiscovery/tunnelx:latest

   Replaceyour_api_key with your ProjectDiscovery API key.

2. Alternatively, build and run locally:

   docker build. -t tunnelxdocker run --network host -d -e PDCP_API_KEY="your_api_key" tunnelx

1. Install and run:

   go install github.com/projectdiscovery/tunnelx@latestexport PDCP_API_KEY="your_api_key"tunnelx

2. Run directly from source:

   git clone https://github.com/projectdiscovery/tunnelx.gitcd tunnelxexport PDCP_API_KEY="your_api_key"go run.

3. Run as a systemd service: If you want to run TunnelX under systemd:

   • Update the deployment/systemd/tunnelx.service file - Set Environment="PDCP_API_KEY=your_api_key_here"
   • Add your username under ExecStart=, User= and set WorkingDirectory= to the TunnelX directory in deployment/systemd/tunnelx.service file.
   • Copy, execute and enable the service:

      sudo cp deployment/systemd/tunnelx.service /etc/systemd/system/tunnelx.service sudo systemctl daemon-reload sudo systemctlenable tunnelx sudo systemctl start tunnelx sudo systemctl status tunnelx

4. After successful connection, navigate toProjectDiscovery Scans to create and manage scans using the established connection.

Example:

tunnelx -auth<your_api_key> -name<custom_network_name>

Output Example:

tunnelx -auth<your_api_key>[INF] Session established. Leave this terminal open toenable continuous discovery and scanning.[INF] Your network is protected—connection isolated and not exposed to the internet.[INF] To create a scan, visit: https://cloud.projectdiscovery.io/scans[HELP] To terminate, press Ctrl+C.

Running in the Background

To keep tunnelx running continuously in the background, follow these instructions based on your operating system:

# Linux & MacOSnohup tunnelx -auth<your_api_key># Windowsstart /B tunnelx -auth<your_api_key>