From 4608e0b628f5323de476be56d4b1dc93dd0dbc1d Mon Sep 17 00:00:00 2001 From: Nick Yeoman Date: Wed, 7 Jun 2023 12:24:14 -0700 Subject: [PATCH] Added finalize page --- Finalize-Script-Documentation.md | 45 ++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 Finalize-Script-Documentation.md diff --git a/Finalize-Script-Documentation.md b/Finalize-Script-Documentation.md new file mode 100644 index 0000000..1fe40f4 --- /dev/null +++ b/Finalize-Script-Documentation.md @@ -0,0 +1,45 @@ +

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:

+
    +
  1. Ensure you have root privileges to run the script.
    2. +
  2. Make sure the .env file exists in the same directory as the script.
    3. +
  3. Execute the script: ./finalize.sh
    4. +
  4. Review the results and commit the changes to Git if necessary.
    5. +
+ +

Configuration

+

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=
+ +

Script Flow

+

The finalize.sh script follows the following flow:

+
    +
  1. Checks if the script is run as root.
    2. +
  2. Verifies the existence of the .env file.
    3. +
  3. Loads the environment variables from the .env file.
    4. +
  4. Sets default values for Joomla configuration options if they are not specified in the .env file.
    5. +
  5. Sets Joomla configuration options using the docker-compose commands.
    6. +
  6. Removes unnecessary Joomla files.
    7. +
  7. Removes install helper scripts.
    8. +
  8. Displays a message to review the results and commit the changes to Git.
    9. +
+ +

Important Notes

+