Merge pull request #36 from moka-guys/docker_ngrok

Docker ngrok (#36)

README.md

@@ -1,4 +1,4 @@
-# Workstation Housekeeping v1.10
+# Workstation Housekeeping v1.11
 
 Scripts to manage data on the NGS workstation
 
@@ -53,17 +53,23 @@ See wscleaner readme for more info
 
 ## ngrok_start.sh
 
-Allow SSH access to the system by running ngrok as a background process.
+Allow SSH access to the system by running ngrok as a background process. As of v1.11 supports dockerised ngrok instance.
 
 ### Installation
 
 See knowledge base article for ngrok installation.
 
 ### Usage
 
-```bash
-$ ngrok_start.sh
-"tcp://30.tcp.eu.ngrok.io:5555"
-```
+Non-dockerised ngrok:
+
+`sudo bash ngrok_start.sh`
+
+Dockerised ngrok:
+
+`sudo bash ngrok_start.sh docker`
+
+### output
+
+The script will output the ngrok connection details
 
----

ngrok_start.sh

@@ -5,14 +5,25 @@
 
 # Get the process ID of ngrok if it is already running on the system
 EXISTING_PROCESS=$(pidof ngrok)
-
+ngrok_instance=$1
+# If ngrok is not running, start as a background process and print the url for SSH access
 if [ -z $EXISTING_PROCESS ] ;then
-  # If ngrok is not running, start as a background process and print the url for SSH access
-  #   nohup [command] : Keep the process running the command even after you quit the session
-  #   ngrok tcp --region eu 22 : Open an connection to ngrok server on port 22
-  #   &> /dev/null : Discard stdout and stderr to empty output stream
-  #   & : Run as a background process
-  nohup ngrok tcp --region eu 22 &> /dev/null &
+  if [[ $ngrok_instance == "docker" ]]; then
+    #   cat the ngrok password into a variable so it can be passed as a environment argument to docker (-e)
+    #   run docker container in detached mode (-d) 
+    #   name the instance
+    #   set --net=host attaches the container to the host network, rather than the docker network - this means ports don't need to be remapped.
+    #   and use ngrok/ngrok:latest tcp --region eu 22 : Open an connection to ngrok server on port 22
+    #   &> /dev/null : Discard stdout and stderr to empty output stream
+    ngrok_token=$(cat /usr/local/src/mokaguys/.ngrok)
+    docker run -d --name NGROK --net=host -it -e NGROK_AUTHTOKEN=$ngrok_token ngrok/ngrok:latest tcp 22 --region eu &> /dev/null
+  else
+    #   nohup [command] : Keep the process running the command even after you quit the session
+    #   ngrok tcp --region eu 22 : Open an connection to ngrok server on port 22
+    #   &> /dev/null : Discard stdout and stderr to empty output stream
+    #   & : Run as a background process
+    nohup ngrok tcp --region eu 22 &> /dev/null &
+  fi
   # Pause for a few seconds to allow the connection to complete.
   sleep 3
   # Write the ngrok public url for SSH access to the syslog.