docker
/
ngrok
1
0
Fork 0
Code Issues Pull Requests 1 Releases Wiki Activity

Update README.md 

Make README friendly on Docker Hub.
This commit is contained in:
Werner Beroux 2015-12-02 14:53:35 +01:00
parent 19d7c23dcf
commit 9a4f20bfed
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,4 +1,5 @@
# ngrok Containerized ngrok
===================
[![](https://badge.imagelayers.io/wernight/ngrok.svg)](https://imagelayers.io/?images=wernight/ngrok:latest 'Get your own badge on imagelayers.io') [![](https://badge.imagelayers.io/wernight/ngrok.svg)](https://imagelayers.io/?images=wernight/ngrok:latest 'Get your own badge on imagelayers.io')
@ -6,14 +7,14 @@ A [Docker][docker] image for [ngrok][ngrok] v2, introspected tunnels to localhos
It's based on the excellent work of [wizardapps/ngrok][wizardapps/ngrok] and [fnichol/ngrok][fnichol/ngrok]. It's based on the excellent work of [wizardapps/ngrok][wizardapps/ngrok] and [fnichol/ngrok][fnichol/ngrok].
## Features ### Features
* **Small**: Built using [busybox][busybox]. * **Small**: Built using [busybox][busybox].
* **Simple**: Just link as `http` or `https` in most cases, see below; exposes ngrok server `4040` port. * **Simple**: Just link as `http` or `https` in most cases, see below; exposes ngrok server `4040` port.
* **Secure**: Runs as non-root user with a random UID `6737` (to avoid mapping to an existing UID). * **Secure**: Runs as non-root user with a random UID `6737` (to avoid mapping to an existing UID).
## Configuration ### Configuration
You simply have to link the Ngrok container to the application under the `app` or `http` or `https` aliases, and all of the configuration will be done for you by default. You simply have to link the Ngrok container to the application under the `app` or `http` or `https` aliases, and all of the configuration will be done for you by default.
@ -29,13 +30,13 @@ Additionally, you can specify one of several environment variable (via `-e`) to
To see command-line options, run `docker run --rm wernight/ngrok --help`. To see command-line options, run `docker run --rm wernight/ngrok --help`.
## Usage ### Usage
Supposing you've an Apache or Nginx Docker container named `web_service_container` listening on port 80: Supposing you've an Apache or Nginx Docker container named `web_service_container` listening on port 80:
$ docker run --rm -it --link web_service_container wernight/ngrok ngrok http web_service_container:80 $ docker run --rm -it --link web_service_container wernight/ngrok ngrok http web_service_container:80
### Full example #### Full example
1. We'll set up a simple example HTTP server in a docker container named `www`: 1. We'll set up a simple example HTTP server in a docker container named `www`:
@ -57,7 +58,7 @@ Supposing you've an Apache or Nginx Docker container named `web_service_containe
$ xdg-open http://$(docker port www_ngrok 4040) $ xdg-open http://$(docker port www_ngrok 4040)
### Helper #### Helper
For common cases you may want to create an alias in your `~/.profile` (or `~/.bashrc`, `~/.zshrc`, or equivalent): For common cases you may want to create an alias in your `~/.profile` (or `~/.bashrc`, `~/.zshrc`, or equivalent):
@ -70,7 +71,7 @@ For common cases you may want to create an alias in your `~/.profile` (or `~/.ba
Then to the simple example just do `docker-ngrok web_service_container`. Then to the simple example just do `docker-ngrok web_service_container`.
## Feedbacks ### Feedbacks
Report issues/questions/feature requests on [GitHub Issues][issues]. Report issues/questions/feature requests on [GitHub Issues][issues].