3846masa/docker-ngrokd

Make your private ngrok with docker-compose.

ngrokd

Product Page

DockerHub

Client Usage

Get client ngrok

Pull 3846masa/ngrok and make release-client (Recommended).

Or download from GitHub Releases.

Settings

Make file $HOME/.ngrok, write settings and rewrite server_addr.

server_addr: example.com:4443
trust_host_root_certs: false

Server Usage

Env

ENV	Description	Required
VHOST_NAME	Based domain. (e.g. *.example.com -> example.com)	Required
CF_API_KEY	CloudFlare API key (See below)	Optional
CF_API_EMAIL	CloudFlare API email (See below)	Optional
VIRTUAL_HOST	nginx-proxy config. (e.g. *.example.com)	Optional
VIRTUAL_PORT	nginx-proxy config. (Recommend: 80)	Optional
HTTPS_METHOD	nginx-proxy config. (Recommend: noredirect)	Optional

Using Docker CLI

Simple

$ docker run -e VHOST_NAME=example.com 3846masa/ngrokd

Advanced

$ docker run 3846masa/ngrokd ngrokd -domain=example.com -log-level=WARNING [...opts]

Using Docker Compose

Edit docker-compose.yml and Run docker-compose up -d.

DNS Settings

Set *.example.com (A/CNAME) Record to your server.

CloudFlare API

When client send -subdomain option, this image can setup CloudFlare Universal SSL automatically.

Using CloudFlare Universal SSL, you should do the following settings.

Crypto

• When you use Flexible SSL, you can access via SSL only.
• If you will access HTTP, please use Full SSL.
  • nginx-proxy and self-signed SSL is easy way.

API Key

• Access account page.
• Account > API Key > Global API Key

LICENSE

(c) 3846masa MIT

Author

3846masa