Documentation

Using Pinggy with Docker

Pinggy provides pre-built Docker images for easily creating tunnels. It can be used to create HTTP(S), TCP, UDP, and TLS tunnels. The only requirement is to have Docker installed.

Here is an example for starting a HTTP tunnel on port 8080 on localhost:

docker run --net=host -it pinggy/pinggy -p 443 -R0:localhost:8080 a.pinggy.io

docker run -it pinggy/pinggy -p 443 -R0:localhost:8080 a.pinggy.io

docker run -it pinggy/pinggy -p 443 -R0:localhost:8080 a.pinggy.io

Note: In linux we need to pass --net=host option to make docker use the same network as the host. For Mac and Windows, we need not pass this option. Instead, internally we replace localhost or 127.0.0.1 to host.docker.internal. This forwards the traffic to the host.

Using Web Debugger

To enable the Web Debugger, you need to pass the option -L0.0.0.0:4300:localhost:4300. You can change the local port to any port you want as: -L0.0.0.0:<port>:localhost:4300. In case of Mac or Windows, you need to map the port also.

docker run --net=host -it pinggy/pinggy -p 443 -R0:localhost:8080 -L4300:localhost:4300 a.pinggy.io

docker run -p 4300:4300 -it pinggy/pinggy -p 443 -R0:localhost:8080 -L0.0.0.0:4300:localhost:4300 a.pinggy.io

docker run -p 4300:4300 -it pinggy/pinggy -p 443 -R0:localhost:8080 -L0.0.0.0:4300:localhost:4300 a.pinggy.io

You can access the web debugger from your browser by visiting: http://localhost:4300

UDP Tunnels

A major advantage of using Pinggy through docker is the ability to create UDP tunnels. Here is an example of a UDP tunnel to port 8000:

docker run --net=host -it pinggy/pinggy -p 443 -R0:localhost:8080 udp@a.pinggy.io

docker run -it pinggy/pinggy -p 443 -R0:localhost:8080 udp@a.pinggy.io

docker run -it pinggy/pinggy -p 443 -R0:localhost:8080 udp@a.pinggy.io

Customizing your tunnel

Any Pinggy configuration will work with the docker container. To learn about more options see Pinggy CLI documentation.

You can log in to https://dashboard.pinggy.io/ and use the tunnel command configuration tool. You just need to make some tweaks to that command to make it work with docker.

For Linux, add --net=host option.

And for the Web Debugger to work in Windows and Mac, make sure to pass -L0.0.0.0:4300:localhost:4300 instead of -L4300:localhost:4300, along with the port mapping -p 4300:4300.