README.md

ngrok agent docker image

Upgrading to v3

We recently rolled out a new version of the agent that requires some changes. You can find an upgrade guide in our docs.

Introduction

This repository contains code related to building and releasing the ngrok docker image

Please visit ngrok's website for more information on what ngrok is.

The ngrok agent docs page has more information on how to use the ngrok agent.

Usage

Run an ngrok agent pointed at localhost:80

...on Linux:

docker run --net=host -it ngrok/ngrok http 80

...on Windows or MacOS:

docker run -it ngrok/ngrok http host.docker.internal:80

Access the web inspector on the host machine at localhost:3000

docker run -it -p 3000:4040 ngrok/ngrok http 80

Run the ngrok agent with auth token 'xyz'

docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:alpine http 80

Run the ngrok agent with the config file './ngrok.yml' from the host machine

docker run -it -v $(pwd)/ngrok.yml:/etc/ngrok.yml -e NGROK_CONFIG=/etc/ngrok.yml ngrok/ngrok:alpine http 80

Tags

described here