style(helpers): reformat helper script
This commit is contained in:
parent
bc2a34ddd8
commit
e208d22664
|
|
@ -6,19 +6,19 @@
|
||||||
|
|
||||||
# text formatting presets
|
# text formatting presets
|
||||||
if command -v tput >/dev/null; then
|
if command -v tput >/dev/null; then
|
||||||
cyan=$(tput bold)$(tput setaf 6)
|
cyan=$(tput bold)$(tput setaf 6)
|
||||||
err=$(tput bold)$(tput setaf 1)
|
err=$(tput bold)$(tput setaf 1)
|
||||||
magenta=$(tput sgr0)$(tput setaf 5)
|
magenta=$(tput sgr0)$(tput setaf 5)
|
||||||
norm=$(tput sgr0)
|
norm=$(tput sgr0)
|
||||||
yellow=$(tput sgr0)$(tput setaf 3)
|
yellow=$(tput sgr0)$(tput setaf 3)
|
||||||
width=$(tput cols)
|
width=$(tput cols)
|
||||||
else
|
else
|
||||||
cyan=''
|
cyan=''
|
||||||
err=''
|
err=''
|
||||||
magenta=''
|
magenta=''
|
||||||
norm=''
|
norm=''
|
||||||
yellow=''
|
yellow=''
|
||||||
width=80
|
width=80
|
||||||
fi
|
fi
|
||||||
|
|
||||||
### parameter defaults
|
### parameter defaults
|
||||||
|
|
@ -36,77 +36,80 @@ unset vmount
|
||||||
### functions
|
### functions
|
||||||
|
|
||||||
checkExist() {
|
checkExist() {
|
||||||
if [ "$1" = 'file' ]; then
|
if [ "$1" = 'file' ]; then
|
||||||
if [ ! -f "$2" ]; then
|
if [ ! -f "$2" ]; then
|
||||||
printf "%s\nCannot find file: '$2'. Exiting.\n%s" "$err" "$norm"
|
printf "%s\nCannot find file: '$2'. Exiting.\n%s" "$err" "$norm"
|
||||||
exit 3
|
exit 3
|
||||||
|
fi
|
||||||
|
elif [ "$1" = 'dir' ]; then
|
||||||
|
if [ ! -d "$2" ]; then
|
||||||
|
printf "%s\nCannot find directory: '$2'. Exiting.\n$%s" "$err" "$norm"
|
||||||
|
exit 3
|
||||||
|
fi
|
||||||
fi
|
fi
|
||||||
elif [ "$1" = 'dir' ]; then
|
return 0
|
||||||
if [ ! -d "$2" ]; then
|
|
||||||
printf "%s\nCannot find directory: '$2'. Exiting.\n$%s" "$err" "$norm"
|
|
||||||
exit 3
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
return 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
scriptHelp() {
|
scriptHelp() {
|
||||||
printf "\n%s%1000s\n" "$magenta" | tr " " "-" | cut -c -$width
|
printf "\n%s" "$magenta"
|
||||||
printf "%s" "$norm"
|
printf '%.0s-' $(seq "$width")
|
||||||
textblock "This is a simple helper script so you can avoid typing lengthy commands when working with the ab-nginx container."
|
printf "\n%s" "$norm"
|
||||||
textblock "The script reads the contents of 'ab-nginx.params' and constructs various 'docker run' commands based on that file. The biggest time-saver is working with certificates. If they are specified in the params file, the script will automatically bind-mount them so nginx serves content via SSL by default."
|
textblock "This is a simple helper script so you can avoid typing lengthy commands when working with the ab-nginx container."
|
||||||
newline
|
textblock "The script reads the contents of 'ab-nginx.params' and constructs various 'docker run' commands based on that file. The biggest time-saver is working with certificates. If they are specified in the params file, the script will automatically bind-mount them so nginx serves content via SSL by default."
|
||||||
textblock "If you run the script with no parameters, it will execute the container 'normally': Run in detached mode with nginx automatically launched. If you specified certificates, nginx will serve over SSL by default."
|
newline
|
||||||
textblock "Note: Containers (except shell) are always set to restart 'unless-stopped'. You must remove them manually if desired."
|
textblock "If you run the script with no parameters, it will execute the container 'normally': Run in detached mode with nginx automatically launched. If you specified certificates, nginx will serve over SSL by default."
|
||||||
printf "%s" "$magenta"
|
textblock "Note: Containers (except shell) are always set to restart 'unless-stopped'. You must remove them manually if desired."
|
||||||
newline
|
printf "%s" "$magenta"
|
||||||
textblock "The script has the following (optional) parameters:"
|
newline
|
||||||
textblockParam 'parameter in cyan' 'default in yellow'
|
textblock "The script has the following (optional) parameters:"
|
||||||
newline
|
textblockParam 'parameter in cyan' 'default in yellow'
|
||||||
textblockParam '-n|--name' 'ab-nginx'
|
newline
|
||||||
textblock "Change the name of the container. This is cosmetic and does not affect operation in any way."
|
textblockParam '-n|--name' 'ab-nginx'
|
||||||
newline
|
textblock "Change the name of the container. This is cosmetic and does not affect operation in any way."
|
||||||
textblockParam '-s|--shell' 'off: run in detached mode'
|
newline
|
||||||
textblock "Enter the container using an interactive ASH/BusyBox shell. This happens after startup operations but *before* nginx is actually started. This is a great way to see configuration changes possibly stopping nginx from starting normally."
|
textblockParam '-s|--shell' 'off: run in detached mode'
|
||||||
printf "%s" "$yellow"
|
textblock "Enter the container using an interactive ASH/BusyBox shell. This happens after startup operations but *before* nginx is actually started. This is a great way to see configuration changes possibly stopping nginx from starting normally."
|
||||||
newline
|
printf "%s" "$yellow"
|
||||||
textblock "More information can be found at: https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki"
|
newline
|
||||||
printf "%s%1000s\n" "$magenta" | tr " " "-" | cut -c -$width
|
textblock "More information can be found at: https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki"
|
||||||
exit 0
|
printf "\n%s" "$magenta"
|
||||||
|
printf '%.0s-' $(seq "$width")
|
||||||
|
printf "\n%s" "$norm"
|
||||||
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
newline() {
|
newline() {
|
||||||
printf "\n"
|
printf "\n"
|
||||||
}
|
}
|
||||||
|
|
||||||
textblock() {
|
textblock() {
|
||||||
printf "%s\n" "$1" | fold -w "$width" -s
|
printf "%s\n" "$1" | fold -w "$width" -s
|
||||||
}
|
}
|
||||||
|
|
||||||
textblockParam() {
|
textblockParam() {
|
||||||
if [ -z "$2" ]; then
|
if [ -z "$2" ]; then
|
||||||
# no default
|
# no default
|
||||||
printf "%s%s%s\n" "$cyan" "$1" "$norm"
|
printf "%s%s%s\n" "$cyan" "$1" "$norm"
|
||||||
else
|
else
|
||||||
# default param provided
|
# default param provided
|
||||||
printf "%s%s %s(%s)%s\n" "$cyan" "$1" "$yellow" "$2" "$norm"
|
printf "%s%s %s(%s)%s\n" "$cyan" "$1" "$yellow" "$2" "$norm"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
### pre-requisite checks
|
### pre-requisite checks
|
||||||
|
|
||||||
# is docker installed?
|
# is docker installed?
|
||||||
if ! command -v docker > /dev/null; then
|
if ! command -v docker >/dev/null; then
|
||||||
printf "%s\nCannot find docker... is it installed?\n%s" "$err" "$norm"
|
printf "%s\nCannot find docker... is it installed?\n%s" "$err" "$norm"
|
||||||
exit 2
|
exit 2
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# is user root or in the docker group?
|
# is user root or in the docker group?
|
||||||
if [ ! "$(id -u)" -eq 0 ]; then
|
if [ ! "$(id -u)" -eq 0 ]; then
|
||||||
if ! id -Gn | grep docker >/dev/null; then
|
if ! id -Gn | grep docker >/dev/null; then
|
||||||
printf "%s\nYou must either be root or in the 'docker' group to run this script since you must be able to actually start the container! Exiting.\n$%s" "$err" "$norm"
|
printf "%s\nYou must either be root or in the 'docker' group to run this script since you must be able to actually start the container! Exiting.\n$%s" "$err" "$norm"
|
||||||
exit 2
|
exit 2
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# does the params file exist?
|
# does the params file exist?
|
||||||
|
|
@ -117,7 +120,7 @@ checkExist 'file' './ab-nginx.params'
|
||||||
|
|
||||||
# fix case of TLS13_ONLY var
|
# fix case of TLS13_ONLY var
|
||||||
if [ "$TLS13_ONLY" ]; then
|
if [ "$TLS13_ONLY" ]; then
|
||||||
TLS13_ONLY=$(printf "%s" "$TLS13_ONLY" | tr "[:lower:]" "[:upper:]")
|
TLS13_ONLY=$(printf "%s" "$TLS13_ONLY" | tr "[:lower:]" "[:upper:]")
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# check for certs if using SSL
|
# check for certs if using SSL
|
||||||
|
|
@ -127,41 +130,41 @@ if [ "$SSL_CHAIN" ]; then checkExist 'file' "$SSL_CHAIN"; fi
|
||||||
|
|
||||||
# check for DHparam if using TLS1.2
|
# check for DHparam if using TLS1.2
|
||||||
if [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'FALSE' ]; then
|
if [ "$SSL_CERT" ] && [ "$TLS13_ONLY" = 'FALSE' ]; then
|
||||||
if [ -z "$DH" ]; then
|
if [ -z "$DH" ]; then
|
||||||
printf "%s\nA DHparam file must be specified when using TLS 1.2. Exiting.%s\n" "$err" "$norm"
|
printf "%s\nA DHparam file must be specified when using TLS 1.2. Exiting.%s\n" "$err" "$norm"
|
||||||
exit 5
|
exit 5
|
||||||
else
|
else
|
||||||
checkExist 'file' "$DH"
|
checkExist 'file' "$DH"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# check if specified config directory exists
|
# check if specified config directory exists
|
||||||
if [ "$CONFIG_DIR" ]; then
|
if [ "$CONFIG_DIR" ]; then
|
||||||
checkExist 'dir' "$CONFIG_DIR"
|
checkExist 'dir' "$CONFIG_DIR"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# check if specified server-block directory exists
|
# check if specified server-block directory exists
|
||||||
if [ "$SERVERS_DIR" ]; then
|
if [ "$SERVERS_DIR" ]; then
|
||||||
checkExist 'dir' "$SERVERS_DIR"
|
checkExist 'dir' "$SERVERS_DIR"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# check if specified webroot directory exists
|
# check if specified webroot directory exists
|
||||||
if [ "$WEBROOT_DIR" ]; then
|
if [ "$WEBROOT_DIR" ]; then
|
||||||
checkExist 'dir' "$WEBROOT_DIR"
|
checkExist 'dir' "$WEBROOT_DIR"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# set up volume mounts
|
# set up volume mounts
|
||||||
if [ "$CONFIG_DIR" ]; then
|
if [ "$CONFIG_DIR" ]; then
|
||||||
vmount="$vmount -v $CONFIG_DIR:/etc/nginx/config"
|
vmount="$vmount -v $CONFIG_DIR:/etc/nginx/config"
|
||||||
fi
|
fi
|
||||||
if [ "$SERVERS_DIR" ]; then
|
if [ "$SERVERS_DIR" ]; then
|
||||||
vmount="$vmount -v $SERVERS_DIR:/etc/nginx/sites"
|
vmount="$vmount -v $SERVERS_DIR:/etc/nginx/sites"
|
||||||
fi
|
fi
|
||||||
if [ "$SNIPPETS_DIR" ]; then
|
if [ "$SNIPPETS_DIR" ]; then
|
||||||
vmount="$vmount -v $SNIPPETS_DIR:/etc/nginx/snippets"
|
vmount="$vmount -v $SNIPPETS_DIR:/etc/nginx/snippets"
|
||||||
fi
|
fi
|
||||||
if [ "$WEBROOT_DIR" ]; then
|
if [ "$WEBROOT_DIR" ]; then
|
||||||
vmount="$vmount -v $WEBROOT_DIR:/usr/share/nginx/html"
|
vmount="$vmount -v $WEBROOT_DIR:/usr/share/nginx/html"
|
||||||
fi
|
fi
|
||||||
# trim leading whitespace
|
# trim leading whitespace
|
||||||
vmount=${vmount##[[:space:]]}
|
vmount=${vmount##[[:space:]]}
|
||||||
|
|
@ -171,68 +174,68 @@ if [ -z "$HOSTNAMES" ]; then HOSTNAMES="_"; fi
|
||||||
|
|
||||||
# process startup parameters
|
# process startup parameters
|
||||||
while [ $# -gt 0 ]; do
|
while [ $# -gt 0 ]; do
|
||||||
case "$1" in
|
case "$1" in
|
||||||
-h | -\? | --help)
|
-h | -\? | --help)
|
||||||
# display help
|
# display help
|
||||||
scriptHelp
|
scriptHelp
|
||||||
exit 0
|
exit 0
|
||||||
;;
|
;;
|
||||||
-s | --shell)
|
-s | --shell)
|
||||||
# start shell instead of default CMD
|
# start shell instead of default CMD
|
||||||
doShell=true
|
doShell=true
|
||||||
;;
|
;;
|
||||||
-n | --name)
|
-n | --name)
|
||||||
# container name
|
# container name
|
||||||
if [ -z "$2" ]; then
|
if [ -z "$2" ]; then
|
||||||
printf "%s\nNo container name specified. Exiting.\n%s" "$err" "$norm"
|
printf "%s\nNo container name specified. Exiting.\n%s" "$err" "$norm"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
container_name="$2"
|
container_name="$2"
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
printf "%s\nUnknown option: %s\n" "$err" "$1"
|
||||||
|
printf "Use '--help' for valid options.\n\n%s" "$norm"
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
shift
|
shift
|
||||||
;;
|
|
||||||
*)
|
|
||||||
printf "%s\nUnknown option: %s\n" "$err" "$1"
|
|
||||||
printf "Use '--help' for valid options.\n\n%s" "$norm"
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
shift
|
|
||||||
done
|
done
|
||||||
|
|
||||||
# create network if it doesn't already exist
|
# create network if it doesn't already exist
|
||||||
docker network inspect ${NETWORK} >/dev/null 2>&1 ||
|
docker network inspect ${NETWORK} >/dev/null 2>&1 ||
|
||||||
docker network create \
|
docker network create \
|
||||||
--attachable \
|
--attachable \
|
||||||
--driver=bridge \
|
--driver=bridge \
|
||||||
--subnet=${SUBNET} \
|
--subnet=${SUBNET} \
|
||||||
${NETWORK}
|
${NETWORK}
|
||||||
|
|
||||||
# run without TLS
|
# run without TLS
|
||||||
if [ -z "$SSL_CERT" ]; then
|
if [ -z "$SSL_CERT" ]; then
|
||||||
if [ "$doShell" = 'true' ]; then
|
if [ "$doShell" = 'true' ]; then
|
||||||
# exec shell
|
# exec shell
|
||||||
printf "%s\nRunning SHELL on %s...%s\n" "$cyan" "$container_name" "$norm"
|
printf "%s\nRunning SHELL on %s...%s\n" "$cyan" "$container_name" "$norm"
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
docker run --rm -it --name "${container_name}" \
|
docker run --rm -it --name "${container_name}" \
|
||||||
--env-file ab-nginx.params \
|
--env-file ab-nginx.params \
|
||||||
-e SERVER_NAMES="$HOSTNAMES" \
|
-e SERVER_NAMES="$HOSTNAMES" \
|
||||||
$vmount \
|
$vmount \
|
||||||
--network=${NETWORK} \
|
--network=${NETWORK} \
|
||||||
-p ${HTTP_PORT}:80 \
|
-p ${HTTP_PORT}:80 \
|
||||||
docker.asifbacchus.dev/nginx/ab-nginx:latest /bin/sh
|
docker.asifbacchus.dev/nginx/ab-nginx:latest /bin/sh
|
||||||
else
|
else
|
||||||
# exec normally
|
# exec normally
|
||||||
printf "%s\nRunning NGINX on %s...%s\n" "$cyan" "$container_name" "$norm"
|
printf "%s\nRunning NGINX on %s...%s\n" "$cyan" "$container_name" "$norm"
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
docker run -d --name "${container_name}" \
|
docker run -d --name "${container_name}" \
|
||||||
--env-file ab-nginx.params \
|
--env-file ab-nginx.params \
|
||||||
-e SERVER_NAMES="$HOSTNAMES" \
|
-e SERVER_NAMES="$HOSTNAMES" \
|
||||||
$vmount \
|
$vmount \
|
||||||
--network=${NETWORK} \
|
--network=${NETWORK} \
|
||||||
-p ${HTTP_PORT}:80 \
|
-p ${HTTP_PORT}:80 \
|
||||||
--restart unless-stopped \
|
--restart unless-stopped \
|
||||||
docker.asifbacchus.dev/nginx/ab-nginx:${TAG:-latest}
|
docker.asifbacchus.dev/nginx/ab-nginx:${TAG:-latest}
|
||||||
fi
|
fi
|
||||||
# run with TLS
|
# run with TLS
|
||||||
else
|
else
|
||||||
if [ "$doShell" = 'true' ]; then
|
if [ "$doShell" = 'true' ]; then
|
||||||
|
|
@ -243,15 +246,15 @@ else
|
||||||
fi
|
fi
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
docker run --rm -it --name "${container_name}" \
|
docker run --rm -it --name "${container_name}" \
|
||||||
--env-file ab-nginx.params \
|
--env-file ab-nginx.params \
|
||||||
-e SERVER_NAMES="$HOSTNAMES" \
|
-e SERVER_NAMES="$HOSTNAMES" \
|
||||||
$vmount \
|
$vmount \
|
||||||
--network=${NETWORK} \
|
--network=${NETWORK} \
|
||||||
-v "$SSL_CERT":/certs/fullchain.pem:ro \
|
-v "$SSL_CERT":/certs/fullchain.pem:ro \
|
||||||
-v "$SSL_KEY":/certs/privkey.pem:ro \
|
-v "$SSL_KEY":/certs/privkey.pem:ro \
|
||||||
-v "$SSL_CHAIN":/certs/chain.pem:ro \
|
-v "$SSL_CHAIN":/certs/chain.pem:ro \
|
||||||
-p ${HTTP_PORT}:80 -p ${HTTPS_PORT}:443 \
|
-p ${HTTP_PORT}:80 -p ${HTTPS_PORT}:443 \
|
||||||
docker.asifbacchus.dev/nginx/ab-nginx:${TAG:-latest} /bin/sh
|
docker.asifbacchus.dev/nginx/ab-nginx:${TAG:-latest} /bin/sh
|
||||||
else
|
else
|
||||||
if [ "$TLS13_ONLY" = 'FALSE' ]; then
|
if [ "$TLS13_ONLY" = 'FALSE' ]; then
|
||||||
printf "%s\nRunning NGINX on %s (TLS 1.2)...%s\n" "$cyan" "$container_name" "$norm"
|
printf "%s\nRunning NGINX on %s (TLS 1.2)...%s\n" "$cyan" "$container_name" "$norm"
|
||||||
|
|
@ -260,16 +263,16 @@ else
|
||||||
fi
|
fi
|
||||||
# shellcheck disable=SC2086
|
# shellcheck disable=SC2086
|
||||||
docker run -d --name "${container_name}" \
|
docker run -d --name "${container_name}" \
|
||||||
--env-file ab-nginx.params \
|
--env-file ab-nginx.params \
|
||||||
-e SERVER_NAMES="$HOSTNAMES" \
|
-e SERVER_NAMES="$HOSTNAMES" \
|
||||||
$vmount \
|
$vmount \
|
||||||
--network=${NETWORK} \
|
--network=${NETWORK} \
|
||||||
-v "$SSL_CERT":/certs/fullchain.pem:ro \
|
-v "$SSL_CERT":/certs/fullchain.pem:ro \
|
||||||
-v "$SSL_KEY":/certs/privkey.pem:ro \
|
-v "$SSL_KEY":/certs/privkey.pem:ro \
|
||||||
-v "$SSL_CHAIN":/certs/chain.pem:ro \
|
-v "$SSL_CHAIN":/certs/chain.pem:ro \
|
||||||
-p ${HTTP_PORT}:80 -p ${HTTPS_PORT}:443 \
|
-p ${HTTP_PORT}:80 -p ${HTTPS_PORT}:443 \
|
||||||
--restart unless-stopped \
|
--restart unless-stopped \
|
||||||
docker.asifbacchus.dev/nginx/ab-nginx:${TAG:-latest}
|
docker.asifbacchus.dev/nginx/ab-nginx:${TAG:-latest}
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue