ngrok agent docker image

Introduction

This repository contains the code for building and releasing the ngrok docker image.

ngrok is an API gateway cloud service that forwards traffic from internet-accessible endpoint URLs to applications running anywhere.

Quick Links:

• ngrok website
• ngrok docs
• ngrok Docker Hub repository

Tags

We offer the following image tags. All tags below are multi-architecture and come in 32- and 64-bit flavors for both ARM and x86.

• :latest, :debian - The latest Debian-based build of the ngrok agent.
• :alpine - The latest Alpine-based build of the ngrok agent.
• :3, :3-debian - The latest Debian build for version 3 of the ngrok agent. Available for every major version from v3 and up.
• :3-alpine - The latest Alpine build for version 3 of the ngrok agent. Available for every major version from v3 and up.
• :<version>-debian - Debian builds for specific versions of the ngrok agent. Available for every minor version from 2.3.40 and up.
• :<version>-alpine - Alpine builds for specific versions of the ngrok agent. Available for every minor version from 2.3.40 and up.
• :<version>-debian-<hash> - Immutable tags pointing to the Debian build of the ngrok agent for a specific version. Available for every build we release.
• :<version>-alpine-<hash> - Immutable tags pointing to the Alpine build of the ngrok agent for a specific version. Available for every build we release.

Quick Start

Linux

# Forward a public endpoint URL to port 80 on your local machine
docker run --net=host -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest http 80

Windows or macOS

docker run -it -e NGROK_AUTHTOKEN=xyz ngrok/ngrok:latest http host.docker.internal:80

For macOS and Windows, you must use the special URL host.docker.internal as described in the Docker networking documentation.

This also applies to the upstream.url endpoint property in your ngrok config file. For example:

endpoints:
  - name: example
    url: https://example.ngrok.app
    upstream:
      url: http://host.docker.internal:80

Usage

For usage, see Using ngrok with Docker.

Configuration

Environment Variables

• NGROK_AUTHTOKEN: Your ngrok authentication token
• NGROK_CONFIG: Path to configuration file (default: /etc/ngrok.yml). See: config file docs

Upgrading to v3

If you're using a v2 agent still, follow the upgrade guide in our docs.

How do I know what version my ngrok container image is?

docker run -it ngrok/ngrok version