Merge pull request #591 from cytopia/ngrok

Make Ngrok region configurable via NGROK_REGION env var
cytopia · Jun 11, 2019 · 0543f2d · 0543f2d
2 parents 3dec841 + 9b5e19c
commit 0543f2d
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ major versions.
 
 
 
+## Unreleased
+
+#### Added
+- Make Ngrok region configurable via `NGROK_REGION` env variable
+
+
 ## Bugfix Release v1.0.2 (2019-05-21)
 
 #### Fixed

diff --git a/compose/docker-compose.override.yml-all b/compose/docker-compose.override.yml-all
@@ -45,11 +45,12 @@ services:
   # Ngrok
   # -----------------------------------------------------------------------------------------------
   ngrok:
-    image: devilbox/ngrok:0.2
+    image: devilbox/ngrok:0.3
     hostname: ngrok
     environment:
       - HTTP_TUNNELS=${NGROK_HTTP_TUNNELS:-httpd:httpd:80}
       - AUTHTOKEN=${NGROK_AUTHTOKEN:-}
+      - REGION=${NGROK_REGION:-us}
     ports:
       - "${LOCAL_LISTEN_ADDR}${HOST_PORT_NGROK:-4040}:4040"
     networks:

diff --git a/compose/docker-compose.override.yml-ngrok b/compose/docker-compose.override.yml-ngrok
@@ -7,11 +7,12 @@ services:
   # Ngrok
   # -----------------------------------------------------------------------------------------------
   ngrok:
-    image: devilbox/ngrok:0.2
+    image: devilbox/ngrok:0.3
     hostname: ngrok
     environment:
       - HTTP_TUNNELS=${NGROK_HTTP_TUNNELS:-httpd:httpd:80}
       - AUTHTOKEN=${NGROK_AUTHTOKEN:-}
+      - REGION=${NGROK_REGION:-us}
     ports:
       - "${LOCAL_LISTEN_ADDR}${HOST_PORT_NGROK:-4040}:4040"
     networks:

diff --git a/docs/custom-container/enable-ngrok.rst b/docs/custom-container/enable-ngrok.rst
@@ -53,23 +53,25 @@ must be copied into the root of the Devilbox git directory.
 +-----------------------+-----------------------------------------------------------------------------------------------------+
 | Available at          | ``http://localhost:4040``                                                                           |
 +-----------------------+-----------------------------------------------------------------------------------------------------+
-| Further configuration | ``NGROK_HTTP_TUNNELS`` and ``NGROK_AUTHTOKEN``                                                      |
+| Further configuration | ``NGROK_HTTP_TUNNELS``, ``NGROK_AUTHTOKEN`` and ``NGROK_REGION``                                    |
 +-----------------------+-----------------------------------------------------------------------------------------------------+
 
 Ngrok env variables
 -------------------
 
 Additionally the following ``.env`` variables can be created for easy configuration:
 
-+------------------------------+--------------------+----------------------------------------------------------------------+
-| Variable                     | Default value      | Description                                                          |
-+==============================+====================+======================================================================+
-| ``HOST_PORT_NGROK``          | ``4040``           | Controls the host port on which Ngrok admin UI will be available at. |
-+------------------------------+--------------------+----------------------------------------------------------------------+
-| ``NGROK_HTTP_TUNNELS``       | ``httpd:httpd:80`` | Defines one or more Ngrok tunnels (depending on your license)        |
-+------------------------------+--------------------+----------------------------------------------------------------------+
-| ``NGROK_AUTHTOKEN``          | empty              | Free or paid license token for Ngrok (can also be empty)             |
-+------------------------------+--------------------+----------------------------------------------------------------------+
++------------------------------+--------------------+----------------------------------------------------------------------------+
+| Variable                     | Default value      | Description                                                                |
++==============================+====================+============================================================================+
+| ``HOST_PORT_NGROK``          | ``4040``           | Controls the host port on which Ngrok admin UI will be available at.       |
++------------------------------+--------------------+----------------------------------------------------------------------------+
+| ``NGROK_HTTP_TUNNELS``       | ``httpd:httpd:80`` | Defines one or more Ngrok tunnels (depending on your license)              |
++------------------------------+--------------------+----------------------------------------------------------------------------+
+| ``NGROK_AUTHTOKEN``          | empty              | Free or paid license token for Ngrok (can also be empty)                   |
++------------------------------+--------------------+----------------------------------------------------------------------------+
+| ``NGROK_REGION``             | ``us``             | Choose the region where the ngrok client will connect to host its tunnels. |
++------------------------------+--------------------+----------------------------------------------------------------------------+
 
 NGROK_HTTP_TUNNELS
 ^^^^^^^^^^^^^^^^^^
@@ -182,6 +184,7 @@ directory:
    echo "NGROK_HTTP_TUNNELS=project1.loc:httpd:80"  >> .env
    echo "# No license token specified"              >> .env
    echo "NGROK_AUTHTOKEN="                          >> .env
+   echo "NGROK_REGION=us"                           >> .env
 
    # Start container
    docker-compose up -d php httpd bind ngrok