ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2025-02-07 11:30:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #591 from cytopia/ngrok

Browse Source 
Make Ngrok region configurable via NGROK_REGION env var
This commit is contained in:
cytopia 2019-06-11 08:58:53 +02:00 committed by GitHub
commit 0543f2da92
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -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) ## Bugfix Release v1.0.2 (2019-05-21)
#### Fixed #### Fixed

3
compose/docker-compose.override.yml-all
View File

@ -45,11 +45,12 @@ services:
# Ngrok # Ngrok
# ----------------------------------------------------------------------------------------------- # -----------------------------------------------------------------------------------------------
ngrok: ngrok:
image: devilbox/ngrok:0.2 image: devilbox/ngrok:0.3
hostname: ngrok hostname: ngrok
environment: environment:
- HTTP_TUNNELS=${NGROK_HTTP_TUNNELS:-httpd:httpd:80} - HTTP_TUNNELS=${NGROK_HTTP_TUNNELS:-httpd:httpd:80}
- AUTHTOKEN=${NGROK_AUTHTOKEN:-} - AUTHTOKEN=${NGROK_AUTHTOKEN:-}
- REGION=${NGROK_REGION:-us}
ports: ports:
- "${LOCAL_LISTEN_ADDR}${HOST_PORT_NGROK:-4040}:4040" - "${LOCAL_LISTEN_ADDR}${HOST_PORT_NGROK:-4040}:4040"
networks: networks:

3
compose/docker-compose.override.yml-ngrok
View File

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

15
docs/custom-container/enable-ngrok.rst
View File

@ -53,7 +53,7 @@ must be copied into the root of the Devilbox git directory.
+-----------------------+-----------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------------------------------------+
| Available at | ``http://localhost:4040`` | | 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 Ngrok env variables
@ -61,15 +61,17 @@ Ngrok env variables
Additionally the following ``.env`` variables can be created for easy configuration: Additionally the following ``.env`` variables can be created for easy configuration:
+------------------------------+--------------------+----------------------------------------------------------------------+ +------------------------------+--------------------+----------------------------------------------------------------------------+
| Variable | Default value | Description | | Variable | Default value | Description |
+==============================+====================+======================================================================+ +==============================+====================+============================================================================+
| ``HOST_PORT_NGROK`` | ``4040`` | Controls the host port on which Ngrok admin UI will be available at. | | ``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_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_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 NGROK_HTTP_TUNNELS
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
@ -182,6 +184,7 @@ directory:
echo "NGROK_HTTP_TUNNELS=project1.loc:httpd:80" >> .env echo "NGROK_HTTP_TUNNELS=project1.loc:httpd:80" >> .env
echo "# No license token specified" >> .env echo "# No license token specified" >> .env
echo "NGROK_AUTHTOKEN=" >> .env echo "NGROK_AUTHTOKEN=" >> .env
echo "NGROK_REGION=us" >> .env
# Start container # Start container
docker-compose up -d php httpd bind ngrok docker-compose up -d php httpd bind ngrok