Ngrok and GoDaddy Connector

README.md

Ngrok and GoDaddy Connector

Ngrok provides a paid service to connect custom domain to a service. This script provides similar functionality which requires to be run everytime ngrok is started/restarted.

It updates your custom domain's CNAME record to the ngrok subdomain assigned to your service.

Usage

$ ./script.sh -n [ngrok name] -k [godaddy key]:[godaddy secret] -d [godaddy domain] -s [godaddy subdomain]

[ngrok name]: Ngrok service name thats deployed (named service can be created using ngrok configuration file)

[godaddy key]:[godaddy secret]: GoDaddy key and secret joined using a colon

[godaddy domain]: Your domain on GoDaddy

[godaddy subdomain]: Subdomain to be created/updated by this script to have ngrok subdomain

script.sh

#!/bin/bash

show_help() {
	echo "$0 -n [ngrok name] -k [godaddy key]:[godaddy secret] -d [godaddy domain] -s [godaddy subdomain]"
}

OPTIND=1

NGROK_NAME=""
GODADDY_KEY_SECRET=""
GODADDY_DOMAIN=""
GODADDY_SUBDOMAIN=""

while getopts "h?n:k:d:s:" opt; do
	case "$opt" in
	h|\?)
		show_help
		exit 0
		;;
	n)	NGROK_NAME=$OPTARG
		;;
	k)	GODADDY_KEY_SECRET=$OPTARG
		;;
	d)	GODADDY_DOMAIN=$OPTARG
		;;
	s)	GODADDY_SUBDOMAIN=$OPTARG
		;;
	esac
done

shift $((OPTIND-1))

[ "${1:-}" = "--" ] && shift

[[ -z "$NGROK_NAME" ]] \
	|| [[ -z "$GODADDY_KEY_SECRET" ]] \
	|| [[ -z "$GODADDY_DOMAIN" ]] \
	|| [[ -z "$GODADDY_SUBDOMAIN" ]] \
	&& echo -e "One or more parameters were missing\n" \
	&& show_help \
	&& exit 1

while [[ -z "$NGROK_DOMAIN" ]]; do
	NGROK_DOMAIN=$(curl -s "http://localhost:4040/api/tunnels" | jq -r ".tunnels[] | select(.name == \"$NGROK_NAME\") | .public_url" | sed -e "s/.*:\/\///")

	[[ -z "$NGROK_DOMAIN" ]] && echo "waiting for ngrok" && sleep 1
done
echo "ngrok domain:" $NGROK_DOMAIN

GODADDY_RESPONSE=$(curl -s -H "Authorization: sso-key $GODADDY_KEY_SECRET" "https://api.godaddy.com/v1/domains/$GODADDY_DOMAIN/records/CNAME/$GODADDY_SUBDOMAIN")
GODADDY_RECORD=$(echo $GODADDY_RESPONSE | jq -r ".[0].data" 2> /dev/null)

[[ $? -ne 0 ]] && echo -e "failed to get godaddy records\n" && (echo $GODADDY_RESPONSE | jq -r .message) && exit 1

if [[ "$GODADDY_RECORD" == "null" ]]; then
	# Create a record if it does not exist
	echo "creating godaddy record"
	GODADDY_RESPONSE=$(curl -f -s -H "Authorization: sso-key $GODADDY_KEY_SECRET" -H "Content-type: application/json" "https://api.godaddy.com/v1/domains/$GODADDY_DOMAIN/records" -X PATCH -d "[{\"name\":\"$GODADDY_SUBDOMAIN\",\"data\": \"$NGROK_DOMAIN\",\"ttl\":600,\"type\":\"CNAME\"}]")

	[[ $? -ne 0 ]] && echo -e "error creating godaddy record\n" && (echo $GODADDY_RESPONSE | jq -r .message) && exit 1
elif [[ "$GODADDY_RECORD" != "$NGROK_DOMAIN" ]]; then
	# Update record
	echo "updating godaddy record"
	GODADDY_RESPONSE=$(curl -f -s -H "Authorization: sso-key $GODADDY_KEY_SECRET" -H "Content-type: application/json" "https://api.godaddy.com/v1/domains/$GODADDY_DOMAIN/records/CNAME/$GODADDY_SUBDOMAIN" -X PUT -d "[{\"name\":\"$GODADDY_SUBDOMAIN\",\"data\": \"$NGROK_DOMAIN\",\"ttl\":600,\"type\":\"CNAME\"}]")

	[[ $? -ne 0 ]] && echo -e "error updating godaddy record\n" && (echo $GODADDY_RESPONSE | jq -r .message) && exit 1

else
	echo "godaddy record:" $GODADDY_RECORD "(matched)"
fi