nick/joomla
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

Added finalize page

Nick Yeoman 2023-06-07 12:24:14 -07:00
parent d570ecee99
commit 4608e0b628
1 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Finalize-Script-Documentation.md Normal file

@ -0,0 +1,45 @@
<h1>finalize.sh Documentation</h1>
<p>The <code>finalize.sh</code> script is designed to perform finalization tasks for a Joomla project. It sets various Joomla configuration options and removes unnecessary files.</p>
<h2>Usage</h2>
<p>To use the <code>finalize.sh</code> script, follow these steps:</p>
<ol>
<li>Ensure you have root privileges to run the script.</li>
<li>Make sure the <code>.env</code> file exists in the same directory as the script.</li>
<li>Execute the script: <code>./finalize.sh</code></li>
<li>Review the results and commit the changes to Git if necessary.</li>
</ol>
<h2>Configuration</h2>
<p>The script reads configuration options from the <code>.env</code> file. Ensure that the following variables are defined:</p>
<pre><code># Joomla Configuration Defaults
JCONFIG_REPORTING=
JCONFIG_TIMEZONE=
JCONFIG_SEF=
# SMTP ENV CHECK
SMTP_MAILER=
SMTP_USER=
SMTP_PASS=
SMTP_HOST=
SMTP_SECURITY=
SMTP_PORT=</code></pre>
<h2>Script Flow</h2>
<p>The <code>finalize.sh</code> script follows the following flow:</p>
<ol>
<li>Checks if the script is run as root.</li>
<li>Verifies the existence of the <code>.env</code> file.</li>
<li>Loads the environment variables from the <code>.env</code> file.</li>
<li>Sets default values for Joomla configuration options if they are not specified in the <code>.env</code> file.</li>
<li>Sets Joomla configuration options using the <code>docker-compose</code> commands.</li>
<li>Removes unnecessary Joomla files.</li>
<li>Removes install helper scripts.</li>
<li>Displays a message to review the results and commit the changes to Git.</li>
</ol>
<h2>Important Notes</h2>
<ul>
<li>Ensure that the <code>docker-compose</code> command is properly configured and available in the environment.</li>
<li>Review the script and customize it according to your specific requirements before running it.</li>
<li>Always make backups of your files and database before running any script that modifies your Joomla installation.</li>
</ul>