adds generic check-diff utility script

.env-example

@@ -4,6 +4,8 @@ DB_NAME=wordpress
 DB_ROOT_PASSWORD=root
 DB_USER=user
 DB_USER_PASSWORD=password
+LARAVEL_VERSION=11.0
+LIVEWIRE_VERSION=3.5.10
 PHP_POST_MAX_SIZE=10m
 PHP_UPLOAD_MAX_FILESIZE=10M
 PREFIX=wpdocker

.gitignore

@@ -1,6 +1,7 @@
 .env
 backup-volumes/
 exclude-list
+root-volume/
 tmp/
 traefik-volumes/
 webroot-remote/

TODO.md

@@ -3,3 +3,11 @@
 - [ ] ajouter un moyen d'accéder à la db via un port
 - [ ] ajouter une option pour créer sans traefik et sans adminer (via override compose)
 - [ ] remplacer -a par --recursive,etc pour éviter qu'rsync n'affiche un transfert si atime, ctime, mtime a changé pour un fichier
+
+# wintercms
+
+- [ ] configurer l'écran de login du back-end en HTTPS
+
+# wordpress
+
+- [ ] documenter wppb-cli

backup.sh

@@ -10,11 +10,14 @@ set -a
 . "${PWD}/.env"
 set +a
 
-now="$(date +%Y-%m_%d-%H-%M-%S)"
+docker compose stop
+
+now="$(date +%Y-%m-%d_%H-%M-%S)"
 backup_path="${PWD}/backup-volumes/${now}"
 mkdir -p "${backup_path}"
 
-volumes="db traefik-dynamic traefik-certs traefik-logs traefik-static webroot"
+volumes="db root traefik-dynamic traefik-certs traefik-logs traefik-static webroot"
+volumes="db"
 for volume in ${volumes}; do
   mkdir -p "${backup_path}/${volume}"
   docker run \
@@ -25,9 +28,24 @@ for volume in ${volumes}; do
     tar -cvzf "/destination/${volume}.tar.gz" -C "/${volume}" .
 done
 
+docker compose restart db
+docker compose restart app
+while ! docker ps -q -f name="${PREFIX}-db"; do
+  echo "Waiting for the db container to be up and running..."
+  sleep 1
+done
+
+while ! docker exec "${PREFIX}-app" /bin/sh -c "mysqladmin ping -h ${PREFIX}-db -P 3306 --protocol=tcp -u user -puser --silent"; do
+  echo "Waiting for the mysql server in the db container to be up and running and reachable from the app container..."
+  sleep 1
+done
+
 mkdir -p "${backup_path}/db"
 docker exec "${PREFIX}-db" \
   /usr/bin/mysqldump \
   -u root \
   --password="${DB_ROOT_PASSWORD}" \
   "${DB_NAME}" > "${backup_path}/db/${DB_NAME}.sql"
+
+docker compose stop db
+docker compose stop app

check-diff.sh

@@ -0,0 +1,35 @@
+#! /bin/sh
+#
+
+set -x
+if [ "$#" -eq 0 ] || [ "$#" -gt 1 ]; then
+  echo takes only one argument
+  exit 1
+fi
+
+if [ ! -e "${1}" ]; then
+  echo cannot find "${1}"
+  exit 1
+fi
+
+# shellcheck source=./env_files/checkdiff-example.env
+. "${1}"
+
+remote_copy_path=$(mktemp -d)
+rsync \
+  --archive \
+  --checksum \
+  --human-readable \
+  "${REMOTE_SSH_STRING}":"${REMOTE_ROOT_PATH}${FOLDER_PATH}/" \
+  "${remote_copy_path}"
+
+local_copy_path=$(mktemp -d)
+rsync \
+  --archive \
+  --checksum \
+  --exclude-from="${EXCLUDEFILE_PATH}" \
+  --human-readable \
+  "${LOCAL_ROOT_PATH}${FOLDER_PATH}/" \
+  "${local_copy_path}"
+
+kdiff3 "${local_copy_path}" "${remote_copy_path}"

create.sh

@@ -9,18 +9,21 @@ fi
 set -a
 . "${PWD}/.env"
 . "${PWD}/env_files/certs.env"
+. "${PWD}/env_files/project.env"
 set +a
 
 mkdir -p "/tmp/${PREFIX}"
 
 echo "Setting up docker volumes"
 docker volume create "${PREFIX}-db"
+docker volume create "${PREFIX}-root"
 docker volume create "${PREFIX}-traefik-certs"
 docker volume create "${PREFIX}-traefik-dynamic"
 docker volume create "${PREFIX}-traefik-logs"
 docker volume create "${PREFIX}-traefik-static"
 docker volume create "${PREFIX}-webroot"
 docker volume create wp-cli-cache
+docker volume create composer-cache
 
 echo "Copying SSL certificates to traefik volume"
 if [ ! -f "${SSL_CRT_LOCATION}/${SSL_CRT_NAME}" ] || [ ! -f "${SSL_KEY_LOCATION}/${SSL_KEY_NAME}" ]; then
@@ -110,44 +113,112 @@ while ! docker exec "${PREFIX}-app" /bin/sh -c "mysqladmin ping -h ${PREFIX}-db
   sleep 1
 done
 
-echo "Downloading WordPress core"
+if [ "${PROJECT_TYPE}" = "laravel" ]; then
-docker exec --user www-data "${PREFIX}-app" /bin/sh -c "
+  echo "Installing laravel"
-    wp core download \
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "composer create-project --prefer-dist laravel/laravel /var/www/html '${LAREVEL_VERSION}'"
-        --locale=${WP_LOCALE} \
+fi
-        --path=/var/www/html \
-        --version=${WP_VERSION}"
 
-echo "Creating WordPress config"
+if [ "${PROJECT_TYPE}" = "livewire" ]; then
-docker exec --user www-data "${PREFIX}-app" /bin/sh -c '
+  echo "Installing livewire"
-    wp config create \
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "composer create-project --prefer-dist laravel/laravel /var/www/html '${LARAVEL_VERSION}'"
-        --dbhost='"${PREFIX}-db"' \
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "composer require livewire/livewire ${LIVEWIRE_VERSION}"
-        --dbname='"${DB_NAME}"' \
+fi
-        --dbpass='"${DB_USER_PASSWORD}"' \
+
-        --dbuser='"${DB_USER}"' \
+if [ "${PROJECT_TYPE}" = "wintercms" ]; then
-        --force \
+  echo "Installing wintercms"
-        --path=/var/www/html \
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "composer create-project wintercms/winter /var/www/html"
-        --skip-check \
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "echo ASSET_URL=https://${APP_URL} >> /var/www/html/.env"
-        --extra-php <<EXTRA-PHP
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "echo DB_DATABASE=${DB_NAME} >> /var/www/html/.env"
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "echo DB_USERNAME=${DB_USER} >> /var/www/html/.env"
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "echo DB_PASSWORD=${DB_USER_PASSWORD} >> /var/www/html/.env"
+  docker exec --user www-data --workdir "/var/www/html" "${PREFIX}-app" /bin/sh -c "echo DB_HOST=${PREFIX}-db >> /var/www/html/.env"
+  docker exec --user root                               "${PREFIX}-app" /bin/sh -c "sed -i 's|/var/www/html/public|/var/www/html|g' /etc/apache2/sites-available/000-default.conf"
+  docker restart "${PREFIX}-app"
+  docker exec --user www-data --workdir "/var/www/html" -it "${PREFIX}-app" /bin/sh -c "php artisan winter:install"
+fi
+
+if [ "${PROJECT_TYPE}" = "laravel" ] || [ "${PROJECT_TYPE}" = "livewire" ] || [ "${PROJECT_TYPE}" = "php" ]; then
+  echo "Generating vscode launch.json file"
+  cat << EOF > /tmp/${PREFIX}/launch.json
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "hostname": "${TRAEFIK_LISTENING_IP}",
+      "name": "Listen for Xdebug (${TRAEFIK_LISTENING_IP})",
+      "pathMappings": {
+        "/var/www/html/": "\${workspaceRoot}/",
+            },
+        "port": 9003,
+        "request": "launch",
+        "type": "php"
+      }
+  ]
+}
+EOF
+  docker run \
+    --rm \
+    --user www-data \
+    --volume "${PREFIX}-app":/destination \
+    ubuntu \
+    mkdir --parents /destination/.vscode
+  docker run \
+    --rm \
+    --user www-data \
+    --volume "${PREFIX}-app":/destination \
+    ubuntu \
+    cp /source/launch.json /destination/.vscode
+  docker run \
+    --rm \
+    --user root \
+    --volume "${PREFIX}-app":/destination \
+    ubuntu \
+   chown www-data:www-data /destination/.vscode -r
+fi
+
+if [ "${PROJECT_TYPE}" = "wordpress" ]; then
+  echo "Installing wppb-cli"
+  composer global require tmeister/wppb-cli
+  echo "Downloading WordPress core"
+  docker exec --user www-data "${PREFIX}-app" /bin/sh -c "
+      wp core download \
+          --locale=${WP_LOCALE} \
+          --path=/var/www/html \
+          --version=${WP_VERSION}"
+  
+  echo "Creating WordPress config"
+  docker exec --user www-data "${PREFIX}-app" /bin/sh -c '
+      wp config create \
+          --dbhost='"${PREFIX}-db"' \
+          --dbname='"${DB_NAME}"' \
+          --dbpass='"${DB_USER_PASSWORD}"' \
+          --dbuser='"${DB_USER}"' \
+          --force \
+          --path=/var/www/html \
+          --skip-check \
+          --extra-php <<EXTRA-PHP
 if (isset(\$_SERVER["HTTP_X_FORWARDED_PROTO"]) && \$_SERVER["HTTP_X_FORWARDED_PROTO"] == "https") \$_SERVER["HTTPS"]="on";
 EXTRA-PHP
 '
   
-echo "Installing WordPress core"
+  echo "Installing WordPress core"
-docker exec --user www-data "${PREFIX}-app" /bin/sh -c "
+  docker exec --user www-data "${PREFIX}-app" /bin/sh -c "
-    wp core install \
+      wp core install \
-        --admin_email=no@mail.com \
+          --admin_email=no@mail.com \
-        --admin_password=${WP_ADMIN_PASSWORD} \
+          --admin_password=${WP_ADMIN_PASSWORD} \
-        --admin_user=${WP_ADMIN_USERNAME} \
+          --admin_user=${WP_ADMIN_USERNAME} \
-        --path=/var/www/html \
+          --path=/var/www/html \
-        --skip-email \
+          --skip-email \
-        --title=${PREFIX} \
+          --title=${PREFIX} \
-        --url=${WP_DEFAULT_PROTOCOL}://${APP_URL}"
+          --url=${WP_DEFAULT_PROTOCOL}://${APP_URL}"
   
-echo "Installing WordPress "${WP_THEME}" theme"
+  echo "Installing WordPress "${WP_THEME}" theme"
-docker exec --user www-data "${PREFIX}-app" /bin/sh -c "
+  docker exec --user www-data "${PREFIX}-app" /bin/sh -c "
-    wp theme install ${WP_THEME} \
+      wp theme install ${WP_THEME} \
-        --activate \
+          --activate \
-        --path=/var/www/html"
+          --path=/var/www/html"
+fi
 
 docker compose up -d adminer
+docker compose up -d app
 docker compose up -d traefik

deploy-directory-to-remote.sh

@@ -29,7 +29,7 @@ if [ "${do_backup}" = "yes" ]; then
   fi
 fi
 
-if [ "${remote_is_docker}" != "yes" ]; then
+if [ "${use_maintenance_mode}" = "yes" ]; then
   if ssh ${remote_ssh_string} "wp option patch update wpmm_settings general status 1 --path=${remote_wp_path}"; then
     echo maintenance mode activated
   else
@@ -47,7 +47,7 @@ else
   exit 1
 fi
 
-if [ "${remote_is_docker}" != "yes" ]; then
+if [ "${use_maintenance_mode}" = "yes" ]; then
   if ssh ${remote_ssh_string} "wp option patch update wpmm_settings general status 0 --path=${remote_wp_path}"; then
     echo maintenance mode deactivated
   else
@@ -56,18 +56,8 @@ if [ "${remote_is_docker}" != "yes" ]; then
   fi
 fi
 
-if [ "${remote_ssh_string}" = "staging" ]; then
+if [ "${restart_remote_varnish}" = "yes" ]; then
   set -x
-  ssh federal sudo service varnish restart
+  ssh "${sudo_remote_ssh_string}" sudo service varnish restart
-  set +x
-fi
-if [ "${remote_ssh_string}" = "prod" ]; then
-  set -x
-  ssh federal sudo service varnish restart
-  set +x
-fi
-if [ "${remote_ssh_string}" = "network" ]; then
-  set -x
-  ssh network sudo service varnish restart
   set +x
 fi

deployment/deployment-example.env

@@ -6,4 +6,7 @@ remote_directory_path=
 remote_ssh_string=
 remote_wp_path=
 remote_is_docker=
+restart_remote_varnish=no
+sudo_remote_ssh_string=
+use_maintenance_mode=no
 do_backup=yes

docker-compose.yml

@@ -25,6 +25,7 @@ services:
       - PHP_UPLOAD_MAX_FILESIZE=${PHP_UPLOAD_MAX_FILESIZE}
       - XDEBUG_CLIENT_HOST=${XDEBUG_CLIENT_HOST}
       - XDEBUG_MODE=${XDEBUG_MODE}
+    hostname: ${PREFIX}-app
     image: ${APP_IMAGE_TAG}
     labels:
       - traefik.enable=true
@@ -36,8 +37,10 @@ services:
       - traefik.http.routers.${PREFIX}-webssl.tls=true
       - traefik.http.services.${PREFIX}-webssl.loadbalancer.server.port=80
     volumes:
+      - root:/root
       - webroot:/var/www/html
       - wp-cli-cache:/var/www/.wp-cli
+      - cache:/var/www/.cache
   db:
     command: --default-authentication-plugin=mysql_native_password
     container_name: ${PREFIX}-db
@@ -75,20 +78,31 @@ services:
       - traefik-logs:/logs
       - traefik-static:/etc/traefik/static:ro
 
-version: "3.4"
-
 volumes:
+  cache:
+    external: true
+    name: composer-cache
   db:
+    external: true
     name: ${PREFIX}-db
+  root:
+    external: true
+    name: ${PREFIX}-root
   traefik-certs:
+    external: true
     name: ${PREFIX}-traefik-certs
   traefik-dynamic:
+    external: true
     name: ${PREFIX}-traefik-dynamic
   traefik-logs:
+    external: true
     name: ${PREFIX}-traefik-logs
   traefik-static:
+    external: true
     name: ${PREFIX}-traefik-static
   webroot:
+    external: true
     name: ${PREFIX}-webroot
   wp-cli-cache:
+    external: true
     name: wp-cli-cache

env_files/certs-example.env

@@ -1,4 +1,4 @@
 SSL_CRT_LOCATION=<path>
-SSL_CRT_NAME<certificate filename>
+SSL_CRT_NAME=<certificate filename>
 SSL_KEY_LOCATION=<path>
 SSL_KEY_NAME=<key filename>

env_files/checkdiff-example.env

@@ -0,0 +1,5 @@
+REMOTE_SSH_STRING=<sshconfig hostname>
+REMOTE_ROOT_PATH=</var/www/example.com/www>
+LOCAL_ROOT_PATH=</home/user/dev/www>
+FOLDER_PATH=</wp-content/themes/bar>
+EXCLUDEFILE_PATH=<./deployment/example.com.bar.exclude>

env_files/project-example.env

@@ -0,0 +1,5 @@
+PROJECT_TYPE=laravel
+PROJECT_TYPE=livewire
+PROJECT_TYPE=php
+PROJECT_TYPE=wintercms
+PROJECT_TYPE=wordpress

env_files/remote-example.env

@@ -1,2 +1,2 @@
 REMOTE_SSH_STRING=<sshconfig hostname>
-REMOTE_WP_PATH=</var/www/example.com.be>
+REMOTE_WP_PATH=</var/www/example.com>

env_files/ssh-tunnel-example.env

@@ -0,0 +1,4 @@
+LOCAL_IP_ON_REMOTE=localhost
+LOCAL_PORT=5432
+LOCAL_PORT_ON_REMOTE=5432
+REMOTE_HOST=federal-non-interactive

mount-volumes.sh

@@ -11,7 +11,7 @@ set -a
 . "${PWD}/env_files/manage.env"
 set +a
 
-volumes="certs dynamic logs static webroot"
+volumes="certs dynamic logs root static webroot"
 for volume in ${volumes}; do
   mount_path="${PWD}/traefik-volumes/${volume}"
   volume_path="${DOCKER_VOLUMES_PATH}/${PREFIX}-traefik-${volume}/_data"
@@ -19,6 +19,10 @@ for volume in ${volumes}; do
     mount_path="${PWD}/${volume}-volume"
     volume_path="${DOCKER_VOLUMES_PATH}/${PREFIX}-${volume}/_data"
   fi
+  if [ "${volume}" = "root" ]; then
+    mount_path="${PWD}/${volume}-volume"
+    volume_path="${DOCKER_VOLUMES_PATH}/${PREFIX}-${volume}/_data"
+  fi
   sudo -u "${MOUNT_USER}" mkdir -p "${mount_path}"
   if mountpoint "${mount_path}" -q; then
     echo "exiting because something is mounted at ${mount_path}"

purge-local.sh

@@ -12,6 +12,7 @@ if [ "$REPLY" != "${REPLY#[YyOo]}" ]; then
   docker compose rm
   docker network rm "${PREFIX}"
   docker volume rm "${PREFIX}-db"
+  docker volume rm "${PREFIX}-root"
   docker volume rm "${PREFIX}-traefik-certs"
   docker volume rm "${PREFIX}-traefik-dynamic"
   docker volume rm "${PREFIX}-traefik-logs"

start-ssh-tunnel.sh

@@ -0,0 +1,24 @@
+#! /bin/sh
+#
+
+if [ "$#" -eq 0 ] || [ "$#" -gt 1 ]; then
+  echo takes only one argument
+  exit 1
+fi
+
+if [ ! -e "${1}" ]; then
+  echo cannot find "${1}"
+  exit 1
+fi
+
+# shellcheck source=./env_files/ssh-tunnel-example.env
+. "${1}"
+# shellcheck source=./.env-example
+. ./.env
+
+ssh \
+  -v \
+  -N \
+  -L \
+  "${TRAEFIK_LISTENING_IP}:${LOCAL_PORT}:${LOCAL_IP_ON_REMOTE}:${LOCAL_PORT_ON_REMOTE}" \
+  "${REMOTE_HOST}"

umount-volumes.sh

@@ -6,12 +6,15 @@ if [ "$(id -u)" -ne 0 ]; then
   exit 1
 fi
 
-volumes="certs dynamic logs static webroot"
+volumes="certs dynamic logs root static webroot"
 for volume in ${volumes}; do
   mount_path="${PWD}/traefik-volumes/${volume}"
   if [ "${volume}" = "webroot" ]; then
     mount_path="${PWD}/${volume}-volume"
   fi
+  if [ "${volume}" = "root" ]; then
+    mount_path="${PWD}/${volume}-volume"
+  fi
   if mountpoint "${mount_path}" -q; then
     echo "umounting ${mount_path}"
     umount "${mount_path}"

www.sh

@@ -6,6 +6,7 @@ set -a
 set +a
 
 docker exec \
+  -e HISTFILE=/var/www/html/.bash_history \
   -e SHELLOPTS=vi \
   -it --user www-data \
   "${PREFIX}-app" \