ab-docker
/
ab-nginx
1
0
Fork 0
Code Issues Pull Requests Releases 7 Wiki Activity

style(helpers): rename textBlock functions 

- rename functions to camelCase
This commit is contained in:
Asif Bacchus 2021-07-27 14:37:57 -06:00
parent a1e2911dc0
commit 3548d88b63
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
helpers/ab-nginx.sh
View File

@ -54,24 +54,24 @@ scriptHelp() {
printf "\n%s" "$magenta" printf "\n%s" "$magenta"
printf '%.0s-' $(seq "$width") printf '%.0s-' $(seq "$width")
printf "\n%s" "$norm" printf "\n%s" "$norm"
textblock "This is a simple helper script so you can avoid typing lengthy commands when working with the ab-nginx container." textBlock "This is a simple helper script so you can avoid typing lengthy commands when working with the ab-nginx container."
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 "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."
newline newline
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." 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."
textblock "Note: Containers (except shell) are always set to restart 'unless-stopped'. You must remove them manually if desired." textBlock "Note: Containers (except shell) are always set to restart 'unless-stopped'. You must remove them manually if desired."
printf "%s" "$magenta" printf "%s" "$magenta"
newline newline
textblock "The script has the following (optional) parameters:" textBlock "The script has the following (optional) parameters:"
textblockParam 'parameter in cyan' 'default in yellow' textBlockParam 'parameter in cyan' 'default in yellow'
newline newline
textblockParam '-n|--name' 'ab-nginx' textBlockParam '-n|--name' 'ab-nginx'
textblock "Set the name of the container, otherwise the default will be used." textBlock "Set the name of the container, otherwise the default will be used."
newline newline
textblockParam '-s|--shell' 'off: run in detached mode' textBlockParam'-s|--shell' 'off: run in detached mode'
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." 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."
printf "%s" "$yellow" printf "%s" "$yellow"
newline newline
textblock "More information can be found at: https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki" textBlock"More information can be found at: https://git.asifbacchus.dev/ab-docker/ab-nginx/wiki"
printf "\n%s" "$magenta" printf "\n%s" "$magenta"
printf '%.0s-' $(seq "$width") printf '%.0s-' $(seq "$width")
printf "\n%s" "$norm" printf "\n%s" "$norm"
@ -82,11 +82,11 @@ 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"