From cc74edc3b64d855b379d4deda2041c80cd131bc8 Mon Sep 17 00:00:00 2001 From: Nick Yeoman Date: Tue, 19 Dec 2023 13:18:11 -0800 Subject: [PATCH] Cleaned up the install process down to 5 steps --- Quick-Start.md | 45 +++++++++++++++++---------------------------- 1 file changed, 17 insertions(+), 28 deletions(-) diff --git a/Quick-Start.md b/Quick-Start.md index e4fbab0..36256d1 100644 --- a/Quick-Start.md +++ b/Quick-Start.md @@ -5,43 +5,32 @@ These are the quick start Joomla installation instructions. Make sure the projectName is set correctly, it's very important, because it's used for git, docker, mysql and joomla. ```bash -# STEP 1 -# Clone the repo (change projectName to the name of your project) -# Context: I like to name my projects by domain, example: nickyeoman-com -git clone git@git.4lt.ca:nick/joomla.git projectName +# STEP 1 - Setup Files +# Clone the repo (change "YourProjectName" to the name of your project) +# Context: I like to name my projects by domain, example: www-4lt-ca +# We then generate a env file based on the project name +export PROJECTNAME='YourProjectName' +git clone git@git.4lt.ca:nick/joomla.git $PROJECTNAME; cd $PROJECTNAME; bash bin/generate_env.sh $PROJECTNAME -# STEP 2 -# Move into the dir -cd projectName +# now ensure that the .env file is to your preferences +# if you are using GITEA and want to auto create the repo, add your GITEA API information to the env file -# STEP 3 -# Setup your env file -cp env.sample.txt .env; cp env.sample.txt .env.staging -# edit your file with any text editor (I use vim) -vi .env - -# STEP 4 -# Prepare your project for git +# STEP 2 - Git work +# Removes Joomla git info that you cloned. Sets up a new repo. If you have set gitea api, creates private repo on remote. bash bin/joomla_new_project.sh -# STEP 5 +# STEP 3 # Run the containers to initialize -sudo docker-compose -f docker-compose.yml -f docker-compose.staging.yml --env-file .env.staging up -d +sudo docker-compose -f docker-compose.yml -f docker-compose.staging.yml up -d -# STEP 6 -# Run the Joomla cli installer (Gotcha: wait until Joomla is up) +# STEP 4 +# Run the Joomla cli installer (Gotcha: wait until Joomla is up by checking http://localhost:8000/) sudo bash bin/joomla_install.sh -# STEP 7 # Manually set Site Meta Description in [Administrator](http://localhost:8000/administrator/index.php?option=com_config) -# Step 8 -# Install Components -sudo bash bin/install_extensions.sh - -# Step 9 -# Clean up and Config (This can be re-run) -sudo bash bin/joomla_cleanup.sh - +# Step 5 +# Install Components and run clean up +sudo bash bin/install_extensions.sh; sudo bash bin/joomla_cleanup.sh ```