diff --git a/Bash-Component-Helpers.md b/Bash-Component-Helpers.md new file mode 100644 index 0000000..90bba51 --- /dev/null +++ b/Bash-Component-Helpers.md @@ -0,0 +1,16 @@ +## Create A Component + +1. Move to the directory where you would like to keep the component. ```cd ~/joomla-components/``` +1. Run component creator from your Joomla install. ```bash ~/projects/joomla/projectName/bin/create_component.sh``` +1. Optionally save to git repo. +1. build the zip file by running bin/build_component.sh + + +### Component Creation References + +* https://github.com/ceford/j4xdemos-com-mywalks/tree/master +* https://www.abdulwaheed.pk/en/blog/41-information-technology/44-joomla/302-how-to-create-joomla-4-component.html +* https://www.techfry.com/resources/how-to-create-joomla-component +* https://docs.joomla.org/J4.x:Developing_an_MVC_Component/Introduction + * [Develop a component](https://docs.joomla.org/J4.x:Developing_an_MVC_Component/Developing_a_Basic_Component) +* [Minimal component](https://joomla.stackexchange.com/questions/22176/minimal-basic-structure-for-a-frontend-joomla-component-without-using-joomla-mvc) \ No newline at end of file diff --git a/Bash-Finalize.md b/Bash-Finalize.md new file mode 100644 index 0000000..8d6cc61 --- /dev/null +++ b/Bash-Finalize.md @@ -0,0 +1,50 @@ +# finalize.sh Documentation + +The ```finalize.sh``` script is designed to perform finalization tasks for a Joomla project. It sets various Joomla configuration options and removes unnecessary files. + +## Usage + +To use the ```finalize.sh``` script, follow these steps: + +* Ensure you have root privileges to run the script. +* Make sure the .env file exists in the same directory as the script. +* Execute the script: ```./finalize.sh``` +* Review the results and commit the changes to Git if necessary. + +## Configuration + +The script reads configuration options from the ```.env``` file. Ensure that the following variables are defined: + +```bash +# Joomla Configuration Defaults +JCONFIG_REPORTING= +JCONFIG_TIMEZONE= +JCONFIG_SEF= +# SMTP ENV CHECK +SMTP_MAILER= +SMTP_USER= +SMTP_PASS= +SMTP_HOST= +SMTP_SECURITY= +SMTP_PORT= +``` + +## Script Flow + +The ```finalize.sh``` script follows the following flow: + +* Checks if the script is run as root. +* Verifies the existence of the ```.env``` file. +* Loads the environment variables from the ```.env``` file. +* Sets default values for Joomla configuration options if they are not specified in the ```.env``` file. +* Sets Joomla configuration options using the ```docker-compose``` commands. +* Removes unnecessary Joomla files. +* Removes install helper scripts. +* Displays a message to review the results and commit the changes to Git. + +## Important Notes + +* Ensure that the ```docker-compose``` command is properly configured and available in the environment. +* Review the script and customize it according to your specific requirements before running it. +* Always make backups of your files and database before running any script that modifies your Joomla installation. + diff --git a/Bash-Scripts---Finalize.md b/Bash-Scripts---Finalize.md deleted file mode 100644 index 1fe40f4..0000000 --- a/Bash-Scripts---Finalize.md +++ /dev/null @@ -1,45 +0,0 @@ -
The finalize.sh
script is designed to perform finalization tasks for a Joomla project. It sets various Joomla configuration options and removes unnecessary files.
To use the finalize.sh
script, follow these steps:
.env
file exists in the same directory as the script../finalize.sh
The script reads configuration options from the .env
file. Ensure that the following variables are defined:
# Joomla Configuration Defaults
-JCONFIG_REPORTING=
-JCONFIG_TIMEZONE=
-JCONFIG_SEF=
-# SMTP ENV CHECK
-SMTP_MAILER=
-SMTP_USER=
-SMTP_PASS=
-SMTP_HOST=
-SMTP_SECURITY=
-SMTP_PORT=
-
- The finalize.sh
script follows the following flow:
.env
file..env
file..env
file.docker-compose
commands.docker-compose
command is properly configured and available in the environment.