Finish provisioning script tools and templates. Set ubuntu-version to 22.04

Author: amurrell

README.md

@@ -13,7 +13,7 @@ Use for **local development of provisioning scripts** (eg. bash scripts) to setu
 - [Overview](#overview) | [Repo Highlights](#repo-highlights)
 - [Install & Use](#install--use)
 - [Pre-Runs](#configure-pre-run-scripts) | [Changing Pre-Runs & Docker Re-Caching](#changing-the-pre-run-script)
-- [Writing Scripts](#scripts) | [Running Scripts](#running-scripts)
+- [Writing Scripts](#scripts) | [Running Scripts](#running-scripts) | [Compiling Scripts](#compiling-scripts)
 - [Configure Dockerfile & docker-compose.yml](#configure-dockerfile-or-docker-compose)
 - [Webserver & Local Development w/ one](#webserver--local-development-with-a-webserver)
 
@@ -151,15 +151,15 @@ Each time you change your pre-run script, you may need to force the docker conta
 
 - **Starting from scratch? Want a boilerplate?**
 
-    If you do not already have scripts or a concept of setup scripts for your stuff yet, then you could use the pre-run example with LEMP-setup-guide.
+    If you do not already have scripts or a concept of setup scripts for your stuff yet, then you can use `./docker-script -n <server-name>` along with `scripts/template/template-main` to generate a boilerplate for you to start with.
 
-    ---
+    You can make your own templates too! Just copy the template-main and edit them to your liking. The variables defined in this file will be dynamically read and prompted for by the `docker-script` command.
 
-    If using this approach, then the script-example could be modified to your own setup:
+    ```
+    ./docker-script -t <template> -n <server-name>
+    ```
 
-    1. In your IDE, open up script-example and copy to a new file - `script-<server-name>`.
-    2. Do a search for all matching "variable" placeholders in the file: `<[^>]*>` with regular expression matching
-    3. Replace all the variables with your own matching information. Change a lot of things to match your situation!
+    This will create a new folder `scripts/script-<your-servername>` with init scripts based on the template-main and other templates scripts we prrovide. You can edit these as needed.
 
     ---
 
@@ -224,16 +224,30 @@ Next, make sure you have put your script into the `scripts` folder with prefix `
 
 Each script should log the output to corresponding log file in your scripts folder (or wherever you want really) eg. `script-my_server_dev.log` or `script-log-my_server_dev.log` to avoid the naming completion being too similar to the script itself.
 
-Then, ssh into your container, ensure your script is executable, and trigger it:
 
 ```
-./docker-ssh
+./docker-run -n my_server_dev
+```
+
+[↑ Contents](#contents)
+
+---
+
+## Compiling Scripts
+
+When you are done testing your scripts, you can compile both the server scripts with the pre-run into one script to run on your cloud server.
+
+```
+./docker-compile -n my_server_dev -p pre-run-example -r
+```
 
-cd /var/www/simple-docker/scripts
+The `-r` flag is optional and means removing emojis from the script. _(linode stack scripts do not like emojis)_.
+The `-p` flag is optional and will default to `pre-run` if not passed.
 
-chmod +x script-my_server_dev
+You will still need the entire `server-<server-name>` folder on your server, which will contain the compiled script. On the cloud, you will then run the compiled script.
 
-./script-my_server_dev
+```
+./compiled-my_server_dev
 ```
 
 [↑ Contents](#contents)

docker-compile

@@ -3,16 +3,34 @@
 set -e
 
 PRE_RUN='pre-run'
-HELP="ℹ️  How to use:\n\t./docker-compile -n <server-name> -p <pre-run>, where the -p is optional if there's an active pre-run already.\n\teg. ./docker-compile -n mysite.com -p pre-run-mysite.com\n"
-# getopts for -p for pre-run (default:pre-run) and require -n for server name, take a -h for help too
-while getopts ":n:p:h" opt; do
+HELP="
+Usage: ./docker-compile -n <server-name> [options]
+
+Options:
+    -n <server-name>        : Name of the server. (Required)
+    -p <pre-run>            : Pre-run script name. (Optional: default is 'pre-run')
+    -r                      : Remove emojis from output. (Optional)
+    -h                      : Display this help message.
+
+Example:
+    ./docker-compile -n mysite.com -p pre-run-mysite.com
+
+Note:
+    The '-p' option is optional if there's an active pre-run already set.
+"
+REMOVE_EMOJIS=false
+# getopts for -p for pre-run (default:pre-run) and require -n for server name, take a -h for help too, -r for remove emojis (optional)
+while getopts ":n:p:rh" opt; do
     case ${opt} in
         n ) # process option n
             SERVER_NAME=$OPTARG
             ;;
         p ) # process option p
             PRE_RUN=$OPTARG
             ;;
+        r ) # process option r
+            REMOVE_EMOJIS=true
+            ;;
         h ) # process option h
             printf "$HELP"
             exit 1
@@ -77,6 +95,20 @@ cp scripts/server-$SERVER_NAME/run-$SERVER_NAME scripts/server-$SERVER_NAME/comp
 # Insert the content of $PRE_RUN into scripts/server-<server-name>/compiled-<server-name> at the #### INSERT PRE-RUN SCRIPT HERE line
 sed -i '' -e "/#### INSERT PRE-RUN SCRIPT HERE/r /dev/stdin" scripts/server-$SERVER_NAME/compiled-$SERVER_NAME <<< "$PRE_RUN"
 
+if [ "$REMOVE_EMOJIS" = true ]; then
+    printf "============ 🧹 Removing emojis from scripts/server-$SERVER_NAME/compiled-$SERVER_NAME\n"
+    # Remove any emojis from scripts/server-<server-name>/compiled-<server-name>
+    tmpfile=$(mktemp)
+    while IFS= read -r line; do
+        if [[ $line == *printf* ]] || [[ $line == *echo* ]]; then
+            echo "$line" | tr -cd '\11\12\15\40-\176' >> "$tmpfile"
+        else
+            echo "$line" >> "$tmpfile"
+        fi
+    done < "scripts/server-$SERVER_NAME/compiled-$SERVER_NAME"
+    mv "$tmpfile" "scripts/server-$SERVER_NAME/compiled-$SERVER_NAME"
+fi
+
 # chmod +x scripts/server-<server-name>/compiled-<server-name>
 chmod +x scripts/server-$SERVER_NAME/compiled-$SERVER_NAME
 

docker-script

@@ -149,9 +149,15 @@ function prompt {
         # replace <variable> with $REPLY but reply is multiline with newlines.
         # escape the REPLY so that it can be used in sed - for /, &, and newlines
         REPLY=$(echo "$REPLY" | sed -e 's/[\/&]/\\&/g' -e 's/$/\\n/' | tr -d '\n')
+
+        # if reply has "null" in it (and possibly new lines), REPLY=null
+        if [[ "$REPLY" == *"null"* ]]; then
+            REPLY="null"
+        fi
+
         sed -i '' -e "s/<$2>/$REPLY/g" scripts/server-$SERVER_NAME/run-$SERVER_NAME
     else
-        sed -i '' -e "s/<$2>/$REPLY/g" scripts/server-$SERVER_NAME/run-$SERVER_NAME
+        sed -i '' -e "s|<$2>|$REPLY|g" scripts/server-$SERVER_NAME/run-$SERVER_NAME
     fi
 }
 

scripts/templates/040-php-config.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+printf "============ Script: PHP Config\n"
+
+PHP_VERSION=$(cat /var/www/LEMP-setup-guide/config/versions/php-version)
+# if override-php-version is set, use that
+if [ -f "/var/www/LEMP-setup-guide/config/versions/override-php-version" ]; then
+    PHP_VERSION=$(cat /var/www/LEMP-setup-guide/config/versions/override-php-version)
+fi
+PHPINI="/etc/php/$PHP_VERSION/fpm/php.ini"
+
+## Adjust INI
+printf "============ Adjust PHP ini - upload max size\n"
+if [ -f "$PHPINI" ]; then
+  sudo sed -i "/;upload_max_filesize = .*/c\upload_max_filesize = 20M" $PHPINI
+  sudo sed -i "/upload_max_filesize = .*/c\upload_max_filesize = 20M" $PHPINI
+  sudo sed -i "/;post_max_size = .*/c\post_max_size = 64M" $PHPINI
+  sudo sed -i "/post_max_size = .*/c\post_max_size = 64M" $PHPINI
+  sudo sed -i "/;memory_limit = .*/c\memory_limit = 256M" $PHPINI
+  sudo sed -i "/memory_limit = .*/c\memory_limit = 256M" $PHPINI
+fi
+

scripts/templates/050-site-example.sh

@@ -13,26 +13,35 @@ printf "============ Script: Site Example\n"
 OWNER_USER='ubuntu'
 DAEMON_USER='www-data'
 SCRIPT_USER='root'
+SERVER='example.com'
 DOMAIN='example.com'
 GITHUB_REPO='https://github.com:amurrell/developer-wordpress.git'
 PHP_VERSION=$(cat /var/www/LEMP-setup-guide/config/versions/php-version)
 # use for location of keys on prod!
 BASE_PATH_DEPLOY_KEYS=/root/devops/config/deployment-keys
+DEPLOY_FOLDER=false
+WEB_ROOT_PATH='html'
+
+THEMENAME='devwp'
+DB_NAME='example_com'
+DB_USER='example'
+DB_PASS='sadhjfhkdsjhfkjdsf'
+
 # if override-php-version is set, use that
 if [ -f "/var/www/LEMP-setup-guide/config/versions/override-php-version" ]; then
     PHP_VERSION=$(cat /var/www/LEMP-setup-guide/config/versions/override-php-version)
 fi
 
-# if using simple-docker, deploy keys are found at /var/www/simple-docker/scripts/server-$DOMAIN/
+# if using simple-docker, deploy keys are found at /var/www/simple-docker/scripts/server-$SERVER/
 # if running via devops repo, deploy keys are found at $BASE_PATH_DEPLOY_KEYS/
-if [ -f "/var/www/simple-docker/scripts/server-$DOMAIN/$DOMAIN-deploy_key.pub" ]; then
-    DEPLOY_KEY_PUBLIC_FILE=/var/www/simple-docker/scripts/server-$DOMAIN/$DOMAIN-deploy_key.pub
+if [ -f "/var/www/simple-docker/scripts/server-$SERVER/$DOMAIN-deploy_key.pub" ]; then
+    DEPLOY_KEY_PUBLIC_FILE=/var/www/simple-docker/scripts/server-$SERVER/$DOMAIN-deploy_key.pub
 else
     DEPLOY_KEY_PUBLIC_FILE=$BASE_PATH_DEPLOY_KEYS/$DOMAIN-deploy_key.pub
 fi
 
-if [ -f "/var/www/simple-docker/scripts/server-$DOMAIN/$DOMAIN-deploy_key" ]; then
-    DEPLOY_KEY_PRIVATE_FILE=/var/www/simple-docker/scripts/server-$DOMAIN/$DOMAIN-deploy_key
+if [ -f "/var/www/simple-docker/scripts/server-$SERVER/$DOMAIN-deploy_key" ]; then
+    DEPLOY_KEY_PRIVATE_FILE=/var/www/simple-docker/scripts/server-$SERVER/$DOMAIN-deploy_key
 else
     DEPLOY_KEY_PRIVATE_FILE=$BASE_PATH_DEPLOY_KEYS/$DOMAIN-deploy_key
 fi
@@ -63,7 +72,7 @@ sudo service nginx start &
 
 # Makr sure php-fpm is running
 printf "============ Make sure php-fpm is running - bc we need it for setup-site\n"
-sudo service php8.2-fpm start &
+sudo service php$PHP_VERSION-fpm start &
 
 
 ## INSTALL Setup-Site
@@ -78,37 +87,31 @@ printf "============ Run as $SCRIPT_USER: Install Site Example Using Setup-Site\
 cd /var/www/LEMP-setup-guide/scripts
 
 # Deployment keys trick:
-# 1st time you run, set these to null and answer prompts to generate keys
+# 1st time you run, cut these out and answer prompts to generate keys
 # - add to github, and store contents (from logs) into files in this servers' scripts folder.
-#   --deploy-key-public-file=null \
-#   --deploy-key-private-file=null \
-# and when you have keys:
 #   --deploy-key-public-file=$DEPLOY_KEY_PUBLIC_FILE \
 #   --deploy-key-private-file=$DEPLOY_KEY_PRIVATE_FILE \
 # or use public repo with https: to avoid needing keys or being prompted for ssh password
 
-# with simple docker testing - use these values
+# with simple docker testing - use these values - or leave them out to use defaults from setup-site
 # --nginx-site-conf-path=/var/www/simple-docker/scripts/templates/site.nginx.conf \
 # --php-site-conf-path=/var/www/simple-docker/scripts/templates/site.php-fpm.conf \
-# but leave these out to use defaults if on production server
 
 ./setup-site \
   --domain=$DOMAIN \
   --owner-user=$OWNER_USER \
   --github=$GITHUB_REPO \
-  --deploy-key-public-file=null \
-    --deploy-key-private-file=null \
+  --deploy-subfolder=$DEPLOY_FOLDER \
+  --web-root-path=$WEB_ROOT_PATH \
   --php-pools=true \
   --nginx-with-php=true \
-  --nginx-site-conf-path=/var/www/simple-docker/scripts/templates/site.nginx.conf \
   --php-with-mysql=true \
-  --php-site-conf-path=/var/www/simple-docker/scripts/templates/site.php-fpm.conf \
   --mysql-create-db=true \
   --mysql-root-user=root \
   --mysql-root-pass=password \
-  --database-name=site_com \
-  --database-user=site.com \
-  --database-pass=cRaZyPaSs \
+  --database-name=$DB_NAME \
+  --database-user=$DB_USER \
+  --database-pass=$DB_PASS \
   --database-host=localhost \
   --database-port=3306
 
@@ -130,14 +133,64 @@ if [ ! -d "/var/www/$DOMAIN/html/wp" ]; then
     rm latest.zip
 fi
 
+# each site needs deploy-commands repo
+printf "============ Installing deploy-commands repo in /var/www/$DOMAIN\n"
+cd /var/www/$DOMAIN
+git clone https://github.com/amurrell/deploy-commands.git
+
+# wordpress deploy
+# if /var/www/deploy-commands/wordpress-deploy exists, ln -s to /var/www/$DOMAIN/commands
+if [ -d "/var/www/$DOMAIN/deploy-commands/wordpress-deploy" ]; then
+    printf "============ /var/www/$DOMAIN/deploy-commands/wordpress-deploy exists so, ln -s to /var/www/$DOMAIN/commands\n"
+    ln -s /var/www/$DOMAIN/deploy-commands/wordpress-deploy /var/www/$DOMAIN/commands
+
+    # add configuration files to this commands folder
+    printf "============ Add configuration files to this commands folder\n"
+    echo "DockerLocal/logs" > /var/www/$DOMAIN/commands/logsfolder
+    echo "html/wp-content/themes/$THEMENAME" > /var/www/$DOMAIN/commands/assetsfolder
+
+    # set OWNER_USER and OWNER_GROUP
+    echo "$OWNER_USER" > /var/www/$DOMAIN/commands/owner_user
+    echo "$DAEMON_USER" > /var/www/$DOMAIN/commands/owner_group
+
+    # need to setup config file apprepo - but make sure we get it with it's special alias
+    # Extract the repository name out of GITHUB_REPO
+    REPO_NAME=${GITHUB_REPO##*/}
+    REPO_NAME=${REPO_NAME%.git}
+    MODIFIED_REPO=${GITHUB_REPO/:/-${REPO_NAME}:}
+    echo $MODIFIED_REPO > /var/www/$DOMAIN/commands/apprepo
+
+    # Example scripts can all be made into real scripts
+    # check if there are any files starting with example_
+    printf "============ Check if there are any bash scripts starting with example_\n"
+    cd /var/www/$DOMAIN/commands
+    if ls example_* 1> /dev/null 2>&1; then
+        printf "============ Found example_ scripts, copying them to scripts without the prefix.\n"
+        for file in example_*; do
+            cp "$file" "${file#example_}"
+            chmod +x "${file#example_}"
+        done
+    fi
+
+    # mkdir for uploads - or copy a zip here in future?
+    printf "============ mkdir for uploads - or copy a zip file later\n"
+    mkdir -p /var/www/$DOMAIN/uploads
+    # ln -s the release - if /var/www/$DOMAIN/current exists, ln -s /var/www/$DOMAIN/uploads /var/www/$DOMAIN/current/html/wp-content/uploads
+    if [ -d "/var/www/$DOMAIN/current" ]; then
+        printf "============ /var/www/$DOMAIN/current exists, ln -s /var/www/$DOMAIN/uploads /var/www/$DOMAIN/current/html/wp-content/uploads\n"
+        ln -s /var/www/$DOMAIN/uploads /var/www/$DOMAIN/current/html/wp-content/uploads
+    fi
+fi
+
 # adjust permissions and ownership on /var/www/$DOMAIN
 printf "============ Adjust permissions and ownership on /var/www/$DOMAIN\n"
 chmod -R 775 /var/www/$DOMAIN
 chown -R $OWNER_USER:$DAEMON_USER /var/www/$DOMAIN
 
-
 # print that we are done
-printf "============ ✅ Setup-Site Script Done - Site Example on simple-docker is at http://localhost:3090/\n\n"
-
-# note that if testing in simple-docker and there are multiple sites, may need to use ProxyLocal with local site.yml configuration
-# that's not tested yet.
+# if /var/www/simple-docker exists, then print message about "SimpleDocker Site Example is at http://localhost:3090"
+if [ -d "/var/www/simple-docker" ]; then
+    printf "============ ✅ Setup-Site Script Done - SimpleDocker Site Example is at http://localhost:3090/\n\n"
+else
+    printf "============ ✅ Setup-Site Script Done.\n\n"
+fi

scripts/templates/site.nginx.conf

@@ -1,12 +1,12 @@
 upstream SITE_COM_backend {
-    server unix:/var/run/php7-fpm.SITEDOTCOM.sock1 weight=100 max_fails=5 fail_timeout=5;
-    server unix:/var/run/php7-fpm.SITEDOTCOM.sock2 weight=100 max_fails=5 fail_timeout=5;
+    server unix:/var/run/php-fpm.SITEDOTCOM.sock1 weight=100 max_fails=5 fail_timeout=5;
+    server unix:/var/run/php-fpm.SITEDOTCOM.sock2 weight=100 max_fails=5 fail_timeout=5;
 }
 
 server {
     listen 80 default_server;
     server_name _;
-    root /var/www/SITEDOTCOM/html;
+    root /var/www/SITEDOTCOM/WEBROOTPATH;
     index index.php index.html;
 
     access_log /var/www/SITEDOTCOM/DockerLocal/logs/access.log;

scripts/templates/site.php-fpm.conf

@@ -1,5 +1,5 @@
 [SITE_COM_1]
-listen = /var/run/php7-fpm.SITEDOTCOM.sock1
+listen = /var/run/php-fpm.SITEDOTCOM.sock1
 listen.allowed_clients = 0.0.0.0
 listen.mode = 0666
 user = www-data
@@ -41,7 +41,7 @@ php_admin_value[session.hash_function] = sha256
 php_admin_value[session.hash_bits_per_character] = 5
 
 [SITE_COM_2]
-listen = /var/run/php7-fpm.SITEDOTCOM.sock2
+listen = /var/run/php-fpm.SITEDOTCOM.sock2
 listen.allowed_clients = 0.0.0.0
 listen.mode = 0666
 user = www-data
@@ -79,4 +79,4 @@ php_admin_value[session.cookie_httponly] = 1
 php_admin_value[session.entropy_length] = 32
 php_admin_value[session.entropy_file] = /dev/urandom
 php_admin_value[session.hash_function] = sha256
-php_admin_value[session.hash_bits_per_character] = 5
+php_admin_value[session.hash_bits_per_character] = 5