commit 17644fc83701d0705bde33dbb8e5ec6c5ca589a2 Author: Llewellyn van der Merwe Date: Wed May 8 16:59:27 2024 +0200 first commit diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..df50810 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,340 @@ +GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9023915 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +# Octoleo Joomla Docker fix + +We add some changes to the official Joomla Docker images, this document helps us remember what these changes are. + +### Our own README + +We have our own readme document, that replace the Joomla official readme, here in this repo its called [joomla-readme.md](https://git.vdm.dev/octoleo/octojdoc/src/joomla-readme.md) + +### Changes to entrypoint.sh + +We have added some code to the entrypoint, the updated version is here in this repo, and is called [joomla-entrypoint.sh](https://git.vdm.dev/octoleo/octojdoc/src/joomla-entrypoint.sh), the code is marked with `####### OCTOLEO ##` and also listed below. + +The Extra Functions +``` +validate_url() { + if [[ $1 =~ ^http(s)?://[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(/.*)?$ ]]; then + return 0 + else + return 1 + fi +} +``` + +The Extra Install actions +``` +# Install any extensions found in the extensions urls env +if [[ -n "${JOOMLA_EXTENSIONS_URLS}" && "${#JOOMLA_EXTENSIONS_URLS}" -gt 2 ]]; then +IFS=';' read -ra ADDR <<< "$JOOMLA_EXTENSIONS_URLS" +for extension_url in "${ADDR[@]}"; do + # Validate each URL + if validate_url "$extension_url"; then + # Try to install the Joomla extension from the URL + if php cli/joomla.php extension:install --url "${extension_url}"; then + echo >&2 "Successfully installed ${extension_url}" + else + echo >&2 "Failed to install ${extension_url}" + fi + else + echo >&2 "Invalid URL: ${extension_url}" + fi +done +fi +# Extract the hostname and port from JOOMLA_SMTP_HOST if it includes ':' +if [[ -n "${JOOMLA_SMTP_HOST}" && "${JOOMLA_SMTP_HOST}" == *:* ]]; then + IFS=':' read -r hostname port <<< "${JOOMLA_SMTP_HOST}" + JOOMLA_SMTP_HOST=$hostname + JOOMLA_SMTP_HOST_PORT=$port +fi +# Update configuration.php if JOOMLA_SMTP_HOST is set and longer than 2 characters +if [[ -n "${JOOMLA_SMTP_HOST}" && "${#JOOMLA_SMTP_HOST}" -gt 2 ]]; then + chmod +w configuration.php + sed -i "s/public \$mailer = 'mail';/public \$mailer = 'smtp';/g" configuration.php + sed -i "s/public \$smtphost = 'localhost';/public \$smtphost = '${JOOMLA_SMTP_HOST}';/g" configuration.php +fi +# Update the SMTP port in configuration.php if JOOMLA_SMTP_HOST_PORT is set + if [[ -n "${JOOMLA_SMTP_HOST_PORT}" ]]; then + sed -i "s/public \$smtpport = 25;/public \$smtpport = ${JOOMLA_SMTP_HOST_PORT};/g" configuration.php + fi +# fix the ownership +if [ "$uid" = '0' ] && [ "$(stat -c '%u:%g' configuration.php)" != "$user:$group" ]; then + # Set configuration to correct owner + if ! chown -R "$user:$group" .; then + echo >&2 + echo >&2 "Error: Ownership of configuration.php failed to be corrected." + fi + # Set configuration to correct permissions + if ! chmod 444 configuration.php; then + echo >&2 + echo >&2 "Error: Permissions of configuration.php failed to be corrected." + fi +fi +``` + +### License + +``` +Copyright (C) 2024 Llewellyn van der Merwe. All rights reserved. +Licensed under the GNU General Public License version 2 or later; see LICENSE.txt +``` + diff --git a/joomla-entrypoint.sh b/joomla-entrypoint.sh new file mode 100644 index 0000000..bbe8781 --- /dev/null +++ b/joomla-entrypoint.sh @@ -0,0 +1,292 @@ +#!/bin/bash +set -e + +if [ -n "$JOOMLA_DB_PASSWORD_FILE" ] && [ -f "$JOOMLA_DB_PASSWORD_FILE" ]; then + JOOMLA_DB_PASSWORD=$(cat "$JOOMLA_DB_PASSWORD_FILE") +fi + +if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then + uid="$(id -u)" + gid="$(id -g)" + if [ "$uid" = '0' ]; then + case "$1" in + apache2*) + user="${APACHE_RUN_USER:-www-data}" + group="${APACHE_RUN_GROUP:-www-data}" + + # strip off any '#' symbol ('#1000' is valid syntax for Apache) + pound='#' + user="${user#$pound}" + group="${group#$pound}" + + # set user if not exist + if ! id "$user" &>/dev/null; then + # get the user name + : "${USER_NAME:=www-data}" + # change the user name + [[ "$USER_NAME" != "www-data" ]] && + usermod -l "$USER_NAME" www-data && + groupmod -n "$USER_NAME" www-data + # update the user ID + groupmod -o -g "$user" "$USER_NAME" + # update the user-group ID + usermod -o -u "$group" "$USER_NAME" + fi + ;; + *) # php-fpm + user='www-data' + group='www-data' + ;; + esac + else + user="$uid" + group="$gid" + fi + + if [ -n "$MYSQL_PORT_3306_TCP" ]; then + if [ -z "$JOOMLA_DB_HOST" ]; then + JOOMLA_DB_HOST='mysql' + else + echo >&2 "warning: both JOOMLA_DB_HOST and MYSQL_PORT_3306_TCP found" + echo >&2 " Connecting to JOOMLA_DB_HOST ($JOOMLA_DB_HOST)" + echo >&2 " instead of the linked mysql container" + fi + fi + + if [ -z "$JOOMLA_DB_HOST" ]; then + echo >&2 "error: missing JOOMLA_DB_HOST and MYSQL_PORT_3306_TCP environment variables" + echo >&2 " Did you forget to --link some_mysql_container:mysql or set an external db" + echo >&2 " with -e JOOMLA_DB_HOST=hostname:port?" + exit 1 + fi + + # If the DB user is 'root' then use the MySQL root password env var + : "${JOOMLA_DB_USER:=root}" + if [ "$JOOMLA_DB_USER" = 'root' ]; then + : ${JOOMLA_DB_PASSWORD:=$MYSQL_ENV_MYSQL_ROOT_PASSWORD} + fi + : "${JOOMLA_DB_NAME:=joomla}" + + if [ -z "$JOOMLA_DB_PASSWORD" ] && [ "$JOOMLA_DB_PASSWORD_ALLOW_EMPTY" != 'yes' ]; then + echo >&2 "error: missing required JOOMLA_DB_PASSWORD environment variable" + echo >&2 " Did you forget to -e JOOMLA_DB_PASSWORD=... ?" + echo >&2 + echo >&2 " (Also of interest might be JOOMLA_DB_USER and JOOMLA_DB_NAME.)" + exit 1 + fi + + if [ ! -e index.php ] && [ ! -e libraries/src/Version.php ]; then + # if the directory exists and Joomla doesn't appear to be installed AND the permissions of it are root:root, let's chown it (likely a Docker-created directory) + if [ "$uid" = '0' ] && [ "$(stat -c '%u:%g' .)" = '0:0' ]; then + chown "$user:$group" . + fi + + echo >&2 "Joomla not found in $PWD - copying now..." + if [ "$(ls -A)" ]; then + echo >&2 "WARNING: $PWD is not empty - press Ctrl+C now if this is an error!" + ( + set -x + ls -A + sleep 10 + ) + fi + # use full commands + # for clearer intent + sourceTarArgs=( + --create + --file - + --directory /usr/src/joomla + --one-file-system + --owner "$user" --group "$group" + ) + targetTarArgs=( + --extract + --file - + ) + if [ "$uid" != '0' ]; then + # avoid "tar: .: Cannot utime: Operation not permitted" and "tar: .: Cannot change mode to rwxr-xr-x: Operation not permitted" + targetTarArgs+=(--no-overwrite-dir) + fi + + tar "${sourceTarArgs[@]}" . | tar "${targetTarArgs[@]}" + + if [ ! -e .htaccess ]; then + # NOTE: The "Indexes" option is disabled in the php:apache base image so remove it as we enable .htaccess + sed -r 's/^(Options -Indexes.*)$/#\1/' htaccess.txt >.htaccess + chown "$user":"$group" .htaccess + fi + + echo >&2 "Complete! Joomla has been successfully copied to $PWD" + fi + + # Ensure the MySQL Database is created + php /makedb.php "$JOOMLA_DB_HOST" "$JOOMLA_DB_USER" "$JOOMLA_DB_PASSWORD" "$JOOMLA_DB_NAME" "${JOOMLA_DB_TYPE:-mysqli}" + + # Basic email regex for validation + email_regex="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$" + + # Function to validate environment variables + validate_vars() { + # Check if JOOMLA_SITE_NAME is longer than 2 characters + if [[ "${#JOOMLA_SITE_NAME}" -le 2 ]]; then + echo >&2 "Error: JOOMLA_SITE_NAME must be longer than 2 characters!" + return 1 + fi + + # Check if JOOMLA_ADMIN_USER is longer than 2 characters + if [[ "${#JOOMLA_ADMIN_USER}" -le 2 ]]; then + echo >&2 "Error: JOOMLA_ADMIN_USER must be longer than 2 characters!" + return 1 + fi + + # Check if JOOMLA_ADMIN_USERNAME has no spaces, and is only alphabetical + if [[ "${JOOMLA_ADMIN_USERNAME}" =~ [^a-zA-Z] ]]; then + echo >&2 "Error: JOOMLA_ADMIN_USERNAME must contain no spaces and be only alphabetical!" + return 1 + fi + + # Check if JOOMLA_ADMIN_PASSWORD is longer than 12 characters + if [[ "${#JOOMLA_ADMIN_PASSWORD}" -le 12 ]]; then + echo >&2 "Error: JOOMLA_ADMIN_PASSWORD must be longer than 12 characters!" + return 1 + fi + + # Check if JOOMLA_ADMIN_EMAIL is a valid email + if [[ ! "${JOOMLA_ADMIN_EMAIL}" =~ $email_regex ]]; then + echo >&2 "Error: JOOMLA_ADMIN_EMAIL must be a valid email address!" + return 1 + fi + + # If all checks passed, return 0 + return 0 + } + + # Function to check that auto deploy can be done + can_auto_deploy() { + # Check if all NEEDED variables exist + if [[ -n "${JOOMLA_SITE_NAME}" && -n "${JOOMLA_ADMIN_USER}" && + -n "${JOOMLA_ADMIN_USERNAME}" && -n "${JOOMLA_ADMIN_PASSWORD}" && + -n "${JOOMLA_ADMIN_EMAIL}" ]]; then + + # All variables exist. Now validate them. + if validate_vars; then + # If all checks passed, return 0 + return 0 + fi + fi + + # If any needed variables does not exist fail, return 1 + return 1 + } +############################ OCTOLEO ## EXTRA FUNCTIONS ######################################################## + validate_url() { + if [[ $1 =~ ^http(s)?://[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(/.*)?$ ]]; then + return 0 + else + return 1 + fi + } +################################################################################################################ + # if the directory exists and we can auto deploy + if [ -d installation ] && [ -e installation/joomla.php ] && can_auto_deploy; then + # use full commands + # for clearer intent + installJoomlaArgs=( + --site-name="${JOOMLA_SITE_NAME}" + --admin-email="${JOOMLA_ADMIN_EMAIL}" + --admin-username="${JOOMLA_ADMIN_USERNAME}" + --admin-user="${JOOMLA_ADMIN_USER}" + --admin-password="${JOOMLA_ADMIN_PASSWORD}" + --db-type="${JOOMLA_DB_TYPE:-mysqli}" + --db-host="${JOOMLA_DB_HOST}" + --db-name="${JOOMLA_DB_NAME}" + --db-pass="${JOOMLA_DB_PASSWORD}" + --db-user="${JOOMLA_DB_USER}" + --db-prefix="${JOOMLA_DB_PREFIX:-joom_}" + --db-encryption=0 + ) + + # Run the auto deploy (install) + if php installation/joomla.php install "${installJoomlaArgs[@]}"; then + + # The PHP command succeeded (so we remove the installation folder) + rm -rf installation + + echo >&2 "========================================================================" + echo >&2 + echo >&2 "This server is now configured to run Joomla!" +############################ OCTOLEO ## EXTRA INSTALL ACTIONS ############################################### + # Install any extensions found in the extensions urls env + if [[ -n "${JOOMLA_EXTENSIONS_URLS}" && "${#JOOMLA_EXTENSIONS_URLS}" -gt 2 ]]; then + IFS=';' read -ra ADDR <<< "$JOOMLA_EXTENSIONS_URLS" + for extension_url in "${ADDR[@]}"; do + # Validate each URL + if validate_url "$extension_url"; then + # Try to install the Joomla extension from the URL + if php cli/joomla.php extension:install --url "${extension_url}"; then + echo >&2 "Successfully installed ${extension_url}" + else + echo >&2 "Failed to install ${extension_url}" + fi + else + echo >&2 "Invalid URL: ${extension_url}" + fi + done + fi + # Extract the hostname and port from JOOMLA_SMTP_HOST if it includes ':' + if [[ -n "${JOOMLA_SMTP_HOST}" && "${JOOMLA_SMTP_HOST}" == *:* ]]; then + IFS=':' read -r hostname port <<< "${JOOMLA_SMTP_HOST}" + JOOMLA_SMTP_HOST=$hostname + JOOMLA_SMTP_HOST_PORT=$port + fi + # Update configuration.php if JOOMLA_SMTP_HOST is set and longer than 2 characters + if [[ -n "${JOOMLA_SMTP_HOST}" && "${#JOOMLA_SMTP_HOST}" -gt 2 ]]; then + chmod +w configuration.php + sed -i "s/public \$mailer = 'mail';/public \$mailer = 'smtp';/g" configuration.php + sed -i "s/public \$smtphost = 'localhost';/public \$smtphost = '${JOOMLA_SMTP_HOST}';/g" configuration.php + fi + # Update the SMTP port in configuration.php if JOOMLA_SMTP_HOST_PORT is set + if [[ -n "${JOOMLA_SMTP_HOST_PORT}" ]]; then + sed -i "s/public \$smtpport = 25;/public \$smtpport = ${JOOMLA_SMTP_HOST_PORT};/g" configuration.php + fi + # fix the ownership + if [ "$uid" = '0' ] && [ "$(stat -c '%u:%g' configuration.php)" != "$user:$group" ]; then + # Set configuration to correct owner + if ! chown -R "$user:$group" .; then + echo >&2 + echo >&2 "Error: Ownership of configuration.php failed to be corrected." + fi + # Set configuration to correct permissions + if ! chmod 444 configuration.php; then + echo >&2 + echo >&2 "Error: Permissions of configuration.php failed to be corrected." + fi + fi +################################################################################################################ + + echo >&2 + echo >&2 "========================================================================" + else + echo >&2 "========================================================================" + echo >&2 + echo >&2 "This server is now configured to run Joomla!" + echo >&2 + echo >&2 "NOTE: You will need your database server address, database name," + echo >&2 "and database user credentials to install Joomla." + echo >&2 + echo >&2 "========================================================================" + fi + else + echo >&2 "========================================================================" + echo >&2 + echo >&2 "This server is now configured to run Joomla!" + echo >&2 + echo >&2 "NOTE: You will need your database server address, database name," + echo >&2 "and database user credentials to install Joomla." + echo >&2 + echo >&2 "========================================================================" + fi +fi + +exec "$@" + diff --git a/joomla-readme.md b/joomla-readme.md new file mode 100644 index 0000000..aee79ca --- /dev/null +++ b/joomla-readme.md @@ -0,0 +1,177 @@ +# Joomla! Octoleo Docker Image + +Welcome to the Joomla! Octoleo project, where we provide Docker images tailored for Joomla! enthusiasts and developers. These images are curated by @llewellynvdm and function as a playground for innovating and testing ideas that could eventually enhance the [official Joomla-Docker](https://github.com/joomla-docker/docker-joomla) images. While these images are experimental and not intended for production use, your feedback and contributions are highly valued. + +[![Docker Pulls](https://img.shields.io/docker/pulls/llewellyn/joomla.svg)](https://hub.docker.com/r/llewellyn/joomla) + +[![Joomla Logo](https://avatars.githubusercontent.com/u/69416061?s=200&v=4)](https://hub.docker.com/r/llewellyn/joomla) + +## Quick Start + +To get started, ensure you have [Docker Compose](https://docs.docker.com/compose/install/) installed. + +### Setting Up Traefik as a Reverse Proxy + +We recommend using [Traefik](https://doc.traefik.io/traefik/) for reverse proxying. Create a `docker-compose.yml` file for Traefik in a directory like `/home/username/Docker/traefik`. + +Here's a basic Traefik configuration: + +```yml +version: "3.3" + +services: + traefik: + container_name: traefik + image: "traefik:latest" + command: + - --entrypoints.web.address=:80 + - --entrypoints.websecure.address=:443 + - --providers.docker + - --log.level=ERROR + - --certificatesresolvers.octoleoresolver.acme.httpchallenge=true + - --certificatesresolvers.octoleoresolver.acme.email=joomla@yourdomain.com + - --certificatesresolvers.octoleoresolver.acme.storage=/acme.json + - --certificatesresolvers.octoleoresolver.acme.httpchallenge.entrypoint=web + - --providers.file.directory=/conf + - --providers.file.watch=true + ports: + - "80:80" + - "443:443" + volumes: + - "/var/run/docker.sock:/var/run/docker.sock:ro" + - "/home/username/Docker/traefik/conf:/conf" + - "/home/username/Docker/traefik/acme.json:/acme.json" + labels: + - "traefik.http.routers.http-catchall.rule=hostregexp(`{host:.+}`)" + - "traefik.http.routers.http-catchall.entrypoints=web" + - "traefik.http.routers.http-catchall.middlewares=redirect-to-https" + - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https" + networks: + - traefik + +networks: + traefik: + external: + name: traefik_webgateway +``` + +Deploy Traefik using: + +```shell +cd /home/username/Docker/traefik +docker network create traefik_webgateway +docker-compose up -d +``` + +### Deploying Joomla + +Choose the Joomla! Docker image version you need. Available tags include: + +- `llewellyn/joomla:latest` +- `llewellyn/joomla:x.x` +- `llewellyn/joomla:x.x-phpx.x` +- `llewellyn/joomla:x.x-phpx.x-variant` + +Find all tags here: [Docker Hub Tags](https://hub.docker.com/r/llewellyn/joomla/tags) + +For Joomla setup, create a `docker-compose.yml` file in `/home/username/Docker/websitename`. + +Example Joomla setup: + +```yml +version: '3.3' + +services: + mariadb_websitename: + image: mariadb:latest + container_name: mariadb_websitename + restart: unless-stopped + environment: + MARIADB_USER: octoleo + MARIADB_DATABASE: octoleo + MARIADB_PASSWORD: your_password_here + MARIADB_ROOT_PASSWORD: your_root_password_here + volumes: + - '/home/username/Projects/websitename/db:/var/lib/mysql' + networks: + - traefik + + joomla_websitename: + image: llewellyn/joomla:5.1 + container_name: joomla_websitename + restart: unless-stopped + environment: + JOOMLA_SITE_NAME: Octoleo + JOOMLA_ADMIN_USER: Octoleo + JOOMLA_ADMIN_USERNAME: octoleo + JOOMLA_ADMIN_PASSWORD: your_password_here + JOOMLA_ADMIN_EMAIL: docker@octoleo.org + JOOMLA_DB_HOST: mariadb_websitename:3306 + JOOMLA_DB_USER: octoleo + JOOMLA_DB_NAME: octoleo + JOOMLA_DB_PASSWORD: your_password_here + JOOMLA_EXTENSIONS_URLS: https://git.vdm.dev/joomla/pkg-component-builder/archive/v5.0.0-rc6.zip + depends_on: + - mariadb_websitename + volumes: + - '/home/username/Projects/websitename/website:/var/www/html' + networks: + - traefik + labels: + - "traefik.enable=true" + - "traefik.http.routers.joomla_websitename.rule=Host(`octoleo.yourdomain.com`)" + - "traefik.http.routers.joomla_websitename.entrypoints=websecure" + - "traefik.http.services.joomla_websitename.loadbalancer.server.port=80" + - "traefik.http.routers.joomla_websitename.service=joomla_websitename" + - "traefik.http.routers.joomla_websitename.tls.certresolver=octoleoresolver" + + phpmyadmin_websitename: + image: phpmyadmin/phpmyadmin + container_name: phpmyadmin_websitename + restart: unless-stopped + environment: + PMA_HOST: mariadb_websitename + PMA_PORT: 3306 + UPLOAD_LIMIT: 300M + depends_on: + - mariadb_websitename + networks: + - traefik + labels: + - "traefik.enable=true" + - "traefik.http.routers.phpmyadmin_websitename.rule=Host(`octoleo-db.yourdomain.com`)" + - "traefik.http.routers.phpmyadmin_websitename.entrypoints=websecure" + - "traefik.http.services.phpmyadmin_websitename.loadbalancer.server.port=80" + - "traefik.http.routers.phpmyadmin_websitename.service=phpmyadmin_websitename" + - "traefik.http.routers.phpmyadmin_websitename.tls.certresolver=octoleoresolver" + +networks: + traefik: + external: + name: traefik_webgateway +``` + +Deploy Joomla using: + +```shell +cd /home/username/Docker/websitename +docker-compose up -d +``` + +## Usage Scenarios + +This setup is ideal for running multiple Joomla instances on the same server. It simplifies access and configuration, especially when paired with a domain service like [Cloudflare](https://cloudflare.com/). + +- Use Cloudflare to point your domain to your server. +- Organize your server with two main directories: **Docker** for Docker Compose files and **Projects** for project-related files. + +Configure Traefik once, and then add as many Joomla containers as needed. Access your Joomla site through your domain, secured with SSL. + +Enjoy experimenting with Joomla on Docker! + +### License + +``` +Copyright (C) 2021 Llewellyn van der Merwe. All rights reserved. +Licensed under the GNU General Public License version 2 or later; see LICENSE.txt +```