xenit/ngrok repository overview

⁠Docker Image for Ngrok

In this repo, ngrok⁠ v2 is packaged as a Docker Image.

⁠Supported tags and respective Dockerfile links

• latest⁠

⁠Usage

You can expose a service running in a docker container, listening on port 8080 with:

$ docker run --rm -it ngrok http <container-ip>:8080

The ngrok client exposes a REST API⁠ to manage the client and is exposed on port 4040 inside the container.

⁠Command-line arguments

To see command-line options, run docker run --rm xenit/ngrok ngrok --help.

⁠Environment variables

If you use the default CMD, without providing any command, there are a few environment variables that can be used instead of the command line arguments.

Note that those have different defaults than the native ngrok binary, because these are slightly tuned to run ngrok from within a docker container.

• NGROK_PROTOCOL - tunnel protocol name: http, tcp, tls (default: http)
• NGROK_REGION - ngrok server region - us, eu, au, ap, sa, jp, in (default: us)
• NGROK_BINDTLS - listen for http, https or both (default: both)
• NGROK_FORWARD - [host:]port to expose (defaults to 80 for http protocol)
• NGROK_LOG - either the path to the log file, stdout, stderr or false (default: stdout)
• NGROK_LOG_FORMAT - log record format term, logfmt, json (default: term)
• NGROK_LOG_LEVEL - logging level debug, info, warn (default: info)

Note that as if you provide your own command, the environment variables won't be used. For more advanced use cases, you can use the command-line options directly.

⁠Feedback

Report issues/questions/feature requests on GitHub Issues⁠

⁠License

Apache 2.0