2 Commits

2 changed files with 91 additions and 34 deletions

View File

@ -1,4 +1,9 @@
# Octojoom - Easy Docker Deployment
<h2><img align="middle" src="https://raw.githubusercontent.com/odb/official-bash-logo/master/assets/Logos/Icons/PNG/64x64.png" >
Octojoom - Easy Joomla! Docker Deployment
</h2>
Written by Llewellyn van der Merwe (@llewellynvdm)
With this script we can easily deploy docker containers of Joomla and Openssh. This combination of these tools give rise to a powerful and very secure shared development environment.
This program has **command input** options as seen in the menus below, but these command are _not the only way_ to set these values.
@ -8,6 +13,8 @@ There are more than one .env file and the script will set those up for you whene
the script will check if those values exist, and if they don't it will ask for them, and store them automatically for future use.
That same time the output message to the terminal will show you where the specific .env file can be found.
Linted by [#ShellCheck](https://github.com/koalaman/shellcheck)
> program only for ubuntu/debian systems at this time (should you like to use it on other OS's please open and issue...)
---

View File

@ -1,8 +1,8 @@
#!/bin/bash
# The most recent program version.
_VERSION="3.4.6"
_V="3.4"
_VERSION="3.5.0"
_V="3.5"
# The program full name
PROGRAM_NAME="Octojoom"
@ -462,6 +462,8 @@ function joomla__TRuST__setup() {
$reset_volume && VDM_VOLUMES=''
# add the projects path
setContainerEnvVariable "VDM_PROJECT_PATH=\"${VDM_PROJECT_PATH}\""
# only if in expert mode set the container user detail id needed
if isExpert; then
# ask if we should add mailcatcher
if (whiptail --yesno "Would you also like to enable mailcatcher for these ${VDM_CONTAINER_TYPE^} containers" \
--defaultno --title "Enable Mailcatcher" --backtitle "${BACK_TITLE}" 8 112); then
@ -485,10 +487,8 @@ function joomla__TRuST__setup() {
fi
VDM_EXTRA_CONTAINER_STUFF+=$(getYMLine3 "- \"traefik.http.routers.mailcatcher${VDM_KEY}.service=mailcatcher${VDM_KEY}\"")
VDM_EXTRA_CONTAINER_STUFF+=$(getYMLine3 "- \"traefik.http.services.mailcatcher${VDM_KEY}.loadbalancer.server.port=1080\"")
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_SMTP_HOST=mailcatcher${VDM_KEY}")
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_SMTP_HOST=mailcatcher${VDM_KEY}:1080")
fi
# only if in expert mode set the container user detail id needed
if isExpert; then
# if this is our octoleo images we can also set the user ID and user-group ID
setContainerUser "$(id -u)"
# check that we got the details
@ -526,6 +526,11 @@ function joomla__TRuST__setup() {
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_ADMIN_EMAIL=\${VDM_${VDM_ENV_KEY^^}_JOOMLA_ADMIN_EMAIL}")
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_ADMIN_PASSWORD=\${VDM_${VDM_ENV_KEY^^}_JOOMLA_ADMIN_PASSWORD}")
fi
if [[ -n "${VDM_J_EXTENSIONS_URLS}" && "${#VDM_J_EXTENSIONS_URLS}" -gt 2 ]]; then
# add extra Joomla envs
setContainerEnvVariable "VDM_${VDM_ENV_KEY^^}_EXTENSIONS_URLS=\"${VDM_J_EXTENSIONS_URLS}\""
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_EXTENSIONS_URLS=\${VDM_${VDM_ENV_KEY^^}_EXTENSIONS_URLS}")
fi
fi
# add PHP settings
VDM_PHP_PROJECT_PATH="${VDM_KEY}"
@ -614,6 +619,7 @@ function joomla__TRuST__setup() {
unset VDM_J_USER
unset VDM_J_EMAIL
unset VDM_J_PASSWORD
unset VDM_J_EXTENSIONS_URLS
# container lower
unset vdm_database_name
unset vdm_database_user
@ -796,11 +802,15 @@ function joomla__TRuST__bulk() {
fi
# we only do autodeploy for Joomla 4.3 and above
enable_autodeploy=false
enable_extension_autodeploy=false
if isVersionAbove "$VDM_JV" "4.3"; then
# get website setup details
setJoomlaWebsiteDetails
if [[ -n "${VDM_J_EMAIL}" ]]; then
enable_autodeploy=true
if [[ -n "${VDM_J_EXTENSIONS_URLS}" && "${#VDM_J_EXTENSIONS_URLS}" -gt 2 ]]; then
enable_extension_autodeploy=true
fi
fi
fi
# add the projects path
@ -869,6 +879,11 @@ function joomla__TRuST__bulk() {
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_ADMIN_USER=\${VDM_${VDM_ENV_KEY^^}_JOOMLA_ADMIN_USER}")
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_ADMIN_EMAIL=\${VDM_${VDM_ENV_KEY^^}_JOOMLA_ADMIN_EMAIL}")
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_ADMIN_PASSWORD=\${VDM_${VDM_ENV_KEY^^}_JOOMLA_ADMIN_PASSWORD}")
if $enable_extension_autodeploy; then
# add extra Joomla envs
setContainerEnvVariable "VDM_${VDM_ENV_KEY^^}_EXTENSIONS_URLS=\"${VDM_J_EXTENSIONS_URLS}\""
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_EXTENSIONS_URLS=\${VDM_${VDM_ENV_KEY^^}_EXTENSIONS_URLS}")
fi
fi
# set persistence
reset_volume=true
@ -917,7 +932,7 @@ function joomla__TRuST__bulk() {
fi
VDM_EXTRA_CONTAINER_STUFF+=$(getYMLine3 "- \"traefik.http.routers.mailcatcher${VDM_KEY}.service=mailcatcher${VDM_KEY}\"")
VDM_EXTRA_CONTAINER_STUFF+=$(getYMLine3 "- \"traefik.http.services.mailcatcher${VDM_KEY}.loadbalancer.server.port=1080\"")
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_SMTP_HOST=mailcatcher${VDM_KEY}")
VDM_EXTRA_JOOMLA_ENV+=$(getYMLine3 "- JOOMLA_SMTP_HOST=mailcatcher${VDM_KEY}:1080")
fi
# setup letsencrypt stuff
VDM_JOOMLA_SECURE_LABELS=''
@ -1002,6 +1017,7 @@ function joomla__TRuST__bulk() {
unset VDM_J_USER
unset VDM_J_EMAIL
unset VDM_J_PASSWORD
unset VDM_J_EXTENSIONS_URLS
# container lower
unset vdm_database_name
unset vdm_database_user
@ -3737,7 +3753,7 @@ function setUniqueKey() {
# set the Joomla website details
function setJoomlaWebsiteDetails() {
# ask if we should add mailcatcher
# ask if we should add autodeployment
if (whiptail --yesno "Would you like to enable website autodeploy for ${VDM_CONTAINER_TYPE,}:${VDM_JV}" \
--defaultno --title "Enable Autodeploy" --backtitle "${BACK_TITLE}" 8 112); then
@ -3756,6 +3772,8 @@ function setJoomlaWebsiteDetails() {
# ask for username password
setJoomlaPassword
# ask for extension URLs
setJoomlaExtensionUrls
fi
}
@ -3846,6 +3864,38 @@ function setJoomlaPassword() {
export VDM_J_PASSWORD
}
# This function asks for Joomla extension ZIP URLs using whiptail, validates them,
# and concatenates them into a single environment variable.
function setJoomlaExtensionUrls() {
local urls=()
local input=""
local prompt_message="Enter Joomla Extension ZIP URL (leave empty to for none):"
local title="Enter Joomla Extension Installation URL"
# Loop to collect URLs until an empty string or cancellation
while true; do
input=$(getInput "$prompt_message" "" "$title")
# Break loop if input is empty
if [[ -z "$input" ]]; then
break
fi
# Validate URL format
if [[ "$input" =~ ^http(s)?://[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(/.*)?$ ]]; then
urls+=("$input")
else
showNotice "Invalid URL. Please enter a valid ZIP URL (must be a .zip file)." 10
fi
done
# Join URLs with semicolons
if [ ${#urls[@]} -gt 0 ]; then
VDM_J_EXTENSIONS_URLS=$(IFS=';'; echo "${urls[*]}")
export VDM_J_EXTENSIONS_URLS
fi
}
# set the number of containers to build
function setNumberContainers() {
local valid=0
@ -3935,7 +3985,7 @@ function setImageSource() {
# get the Joomla version if not set
while [ ${#VDM_JV} -le 1 ]; do
# get the value
VDM_JV=$(getInput "Enter Joomla version tag for this container.\n[See available tags here ${vdm_tag_url}]" '5.0' 'Enter Version Tag')
VDM_JV=$(getInput "Enter Joomla version tag for this container.\n[See available tags here ${vdm_tag_url}]" '5.1' 'Enter Version Tag')
# keep asking
[ ${#VDM_JV} -ge 1 ] || {
showError "You must enter a version tag. See available tags here ${vdm_tag_url}"
@ -4943,8 +4993,8 @@ Usage: octojoom [OPTION...]
======================================================
-j|--joomla-version <version-tag>
see available tags here https://hub.docker.com/_/joomla
example: octojoom -j=5.0
example: octojoom --joomla-version=5.0
example: octojoom -j=5.1
example: octojoom --joomla-version=5.1
======================================================
AVAILABLE FOR OPENSSH CONTAINER
======================================================
@ -5320,7 +5370,7 @@ mkdir -p -m '700' "${VDM_SRC_PATH}"
# first run switch
VDM_FIRST_RUN=false
# load the globals
# shellcheck disable=SC1090
# shellcheck disable=SC1090 source=/dev/null
[ -f "${VDM_SRC_PATH}/.env" ] && source "${VDM_SRC_PATH}/.env"
# get repo path where store the container deploy scripts
while [ ${#VDM_REPO_PATH} -le 1 ] || [ ! -d "${VDM_REPO_PATH}" ]; do