Improve documentation and domain handling scripts

Expanded and clarified the README with improved formatting, updated instructions, and more detailed environment variable explanations. Updated docker-compose.yml to include 'git' in package installation and improved timezone configuration logic. Refined install.sh for better domain/host handling and updated timezone documentation links. Commented out ssl_stapling in nginx SSL options for compatibility.

Author: damalis

README.md

@@ -3,7 +3,8 @@
 If You want to build a website with Laravel at short time;
 
 #### Full stack Apache2 Laravel:
-<p align="left"> <a href="https://laravel.com/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/958072?s=200&v=4" alt="Laravel" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
+<p align="left">
+<a href="https://laravel.com/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/958072?s=200&v=4" alt="Laravel" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://www.docker.com/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/docker/docker.png" alt="docker" width="40" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://mariadb.org/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/5877084?s=200&v=4" alt="mariadb" height="50" width="50"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://dev.mysql.com/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/2452804?s=200&v=4" alt="mysql" height="50" width="50"/> </a>&nbsp;&nbsp;&nbsp; 
@@ -15,7 +16,8 @@ If You want to build a website with Laravel at short time;
 <a href="https://certbot.eff.org/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/17889013?s=200&v=4" alt="certbot" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://letsencrypt.org/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/9289019?s=200&v=4" alt="letsencrypt" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://www.portainer.io/?hsLang=en" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/22225832?s=200&v=4" alt="portainer" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
-<a href="https://www.offen.dev/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/47735043?s=200&v=4" alt="backup" height="35" width="35"/> </a> </p>
+<a href="https://www.offen.dev/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/47735043?s=200&v=4" alt="backup" height="35" width="35"/> </a>
+</p>
 
 Plus, manage docker containers with Portainer.
 
@@ -26,15 +28,17 @@ Plus, manage docker containers with Portainer.
 <p align="left"> apk, dnf, yum, apt/apt-get, zypper, pacman </p>
 
 #### Supported Linux Operation Systems:
-<p align="left"> <a href="https://alpinelinux.org/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/7600810?s=200&v=4" alt="alpine linux" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
+<p align="left">
+<a href="https://alpinelinux.org/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/7600810?s=200&v=4" alt="alpine linux" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://fedoraproject.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/github/explore/e6b1e7f0fb8d0bf920bd719c7289243138bdc1b4/topics/fedora/fedora.png" alt="fedora" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://www.centos.org/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/79192?s=200&v=4" alt="centos" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://www.debian.org/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/1854028?s=200&v=4" alt="debian" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://ubuntu.com/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/4604537?s=200&v=4" alt="ubuntu" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://www.raspberrypi.com/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/1294177?s=200&v=4" alt="ubuntu" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/33972111?s=200&v=4" alt="redhat on s390x (IBM Z)" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
 <a href="https://www.suse.com/products/server/" target="_blank" rel="noreferrer"> <img src="https://avatars.githubusercontent.com/u/623819?s=200&v=4" alt="opensuse on s390x (IBM Z)" height="40" width="40"/> </a>&nbsp;&nbsp;&nbsp; 
-<a href="https://archlinux.org/" target="_blank" rel="noreferrer"> <img src="https://gitlab.archlinux.org/uploads/-/system/group/avatar/23/iconfinder_archlinux_386451.png?width=48" alt="arch linux" height="40" width="40"/> </a> </p>
+<a href="https://archlinux.org/" target="_blank" rel="noreferrer"> <img src="https://gitlab.archlinux.org/uploads/-/system/group/avatar/23/iconfinder_archlinux_386451.png?width=48" alt="arch linux" height="40" width="40"/> </a>
+</p>
 
 ##### Note: Fedora 37, 39 and alpine linux x86-64 compatible, could not try sles IBM Z s390x, rhel IBM Z s390x and raspberrypi.
 
@@ -44,7 +48,7 @@ Plus, manage docker containers with Portainer.
 - [webserver (apache2/httpd)](https://hub.docker.com/_/httpd)
 - [certbot (letsencrypt)](https://hub.docker.com/r/certbot/certbot)
 - [phpMyAdmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/)
-- [databaseMariadb](https://hub.docker.com/_/mariadb) [databaseMysql](https://hub.docker.com/_/mysql)
+- [Mariadb](https://hub.docker.com/_/mariadb) [Mysql](https://hub.docker.com/_/mysql)
 - [redis](https://hub.docker.com/_/redis)
 - [backup](https://hub.docker.com/r/offen/docker-volume-backup)
 
@@ -63,8 +67,10 @@ Create rules to open ports to the internet, or to a specific IPv4 address or ran
 #### Contents:
 
 - [Auto Configuration and Installation](#automatic)
-- [Requirements](#requirements)
 - [Manual Configuration and Installation](#manual)
+	- [Requirements](#requirements)
+	- [Configuration](#configuration)
+	- [Installation](#installation)
 - [Portainer Installation](#portainer)
 - [Usage](#usage)
 	- [Website](#website)
@@ -75,9 +81,9 @@ Create rules to open ports to the internet, or to a specific IPv4 address or ran
 	- [phpMyAdmin](#phpmyadmin)
 	- [backup](#backup)
 
-## Automatic
+### Automatic
 
-### Exec install shell script for auto installation and configuration
+#### Exec install shell script for auto installation and configuration
 
 download with
 
@@ -93,7 +99,9 @@ chmod +x install.sh
 ./install.sh
 ```
 
-## Requirements
+### Manual
+
+#### Requirements
 
 Make sure you have the latest versions of **Docker** and **Docker Compose** installed on your machine.
 
@@ -104,9 +112,7 @@ Clone this repository or copy the files from this repository into a new folder.
 
 Make sure to [add your user to the `docker` group](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user).
 
-## Manual
-
-### Configuration
+#### Configuration
 
 download with
 
@@ -126,40 +132,94 @@ Copy the example environment into `.env`
 cp env.example .env
 ```
 
-Edit the `.env` file to change values of ```LOCAL_TIMEZONE```, ```DOMAIN_NAME```, ```DIRECTORY_PATH```, ```LETSENCRYPT_EMAIL```, ```DB_USER```, ```DB_PASSWORD```, ```DB_NAME```, ```MYSQL_ROOT_PASSWORD```, ```DATABASE_IMAGE_NAME```, ```DATABASE_CONT_NAME```, ```DATABASE_PACKAGE_MANAGER```, ```DATABASE_ADMIN_COMMANDLINE```, ```PMA_CONTROLUSER```, ```PMA_CONTROLPASS```, ```PMA_HTPASSWD_USERNAME``` and ```PMA_HTPASSWD_PASSWORD```.
+Edit the `.env` file to change values of
+
+|```LOCAL_TIMEZONE```|```DOMAIN_NAME```|```DIRECTORY_PATH```|```LETSENCRYPT_EMAIL```|
+|```DB_USER```|```DB_PASSWORD```|```DB_NAME```|```MYSQL_ROOT_PASSWORD```|```DATABASE_IMAGE_NAME```|
+|```DATABASE_CONT_NAME```|```DATABASE_PACKAGE_MANAGER```|```DATABASE_ADMIN_COMMANDLINE```|```PMA_CONTROLUSER```|```PMA_CONTROLPASS```|
+|```PMA_HTPASSWD_USERNAME```|```PMA_HTPASSWD_PASSWORD```|```SSL_SNIPPET```|
+
+<table><thead>
+  <tr>
+    <th>Variable </th>
+    <th colspan="2">Value</th>
+  </tr></thead>
+<tbody>
+  <tr>
+    <td><code>LOCAL_TIMEZONE</code></td>
+    <td colspan="2"><code><a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List" rel="nofollow">to see local timezones</a></code></td>
+  </tr>
+  <tr>
+    <td><code>DIRECTORY_PATH</code></td>
+    <td colspan="2"><code>pwd</code> at command line</td>
+  </tr>
+  <tr>
+    <td><code>DATABASE_IMAGE_NAME</code></td>
+    <td colspan="2"><code>mariadb</code> or <code>mysql</code></td>
+  </tr>
+  <tr>
+    <td><code>DATABASE_CONT_NAME</code></td>
+    <td colspan="2"><code>mariadb</code>, <code>mysql</code> or <code><a href="https://docs.docker.com/reference/compose-file/services/#container_name" rel="nofollow" alt="custom name">custom name</a></code></td>
+  </tr>
+  <tr>
+    <td rowspan="2"><code>DATABASE_PACKAGE_MANAGER</code></td>
+    <td>mariadb</td>
+    <td><code>apt-get update && apt-get install -y gettext-base</code></td>
+  </tr>
+  <tr>
+    <td>mysql</td>
+    <td><code>microdnf install -y gettext</code></td>
+  </tr>
+  <tr>
+    <td rowspan="2"><code>DATABASE_ADMIN_COMMANDLINE</code></td>
+    <td>mariadb</td>
+    <td><code>mariadb-admin</code></td>
+  </tr>
+  <tr>
+    <td>mysql</td>
+    <td><code>mysqladmin</code></td>
+  </tr>
+  <tr>
+    <td rowspan="2"><code>SSL_SNIPPET</code></td>
+    <td>localhost</td>
+    <td><code>echo 'Generated Self-signed SSL Certificate at localhost'</code></td>
+  </tr>
+  <tr>
+    <td>remotehost</td>
+    <td><code>certbot certonly --webroot --webroot-path /tmp/acme-challenge --rsa-key-size 4096 --non-interactive --agree-tos --no-eff-email --force-renewal --email ${LETSENCRYPT_EMAIL} -d ${DOMAIN_NAME} -d www.${DOMAIN_NAME}</code></td>
+  </tr>
+</tbody>
+</table>
 
-LOCAL_TIMEZONE=[to see local timezones](https://docs.diladele.com/docker/timezones.html)
+and
 
-DIRECTORY_PATH=```pwd``` at command line\
-DATABASE_IMAGE_NAME=```mariadb``` or ```mysql```\
-DATABASE_CONT_NAME=```mariadb```, ```mysql``` or ```custom name```\
-DATABASE_PACKAGE_MANAGER=```apt-get update && apt-get install -y gettext-base``` for mariadb, ```microdnf install -y gettext``` for mysql\
-DATABASE_ADMIN_COMMANDLINE=```mariadb-admin``` for mariadb, ```mysqladmin``` for mysql\
-VARNISH_VERSION=```latest``` for centos version 9+ and fedora, ```stable``` for the others\
-SSL_SNIPPET=```echo 'Generated Self-signed SSL Certificate for localhost'``` for localhost\
-SSL_SNIPPET=```certbot certonly --webroot --webroot-path /tmp/acme-challenge --rsa-key-size 4096 --non-interactive --agree-tos --no-eff-email --force-renewal --email ${LETSENCRYPT_EMAIL} -d ${DOMAIN_NAME} -d www.${DOMAIN_NAME}``` for remotehost
+```
+cp ./webserver/extra/httpd-ssl.conf.template ./webserver/extra/httpd-ssl.conf
+```
 
-and
+change example.com to your domain name in ```./webserver/extra/httpd-ssl.conf``` file.
 
 ```
 cp ./phpmyadmin/apache2/sites-available/default-ssl.sample.conf ./phpmyadmin/apache2/sites-available/default-ssl.conf
 ```
+
 change example.com to your domain name in ```./phpmyadmin/apache2/sites-available/default-ssl.conf``` file.
 
 ```
 cp ./database/phpmyadmin/sql/create_tables.sql.template.example ./database/phpmyadmin/sql/create_tables.sql.template
 ```
+
 change pma_controluser and db_authentication_password in ```./database/phpmyadmin/sql/create_tables.sql.template``` file.
 
-### Installation
+#### Installation
 
 Firstly: will create external volume
 
 ```
 docker volume create --driver local --opt type=none --opt device=${PWD}/certbot --opt o=bind certbot-etc
 ```
 
-for localhost ssl: Generate Self-signed SSL Certificate with guide [mkcert repository](https://github.com/FiloSottile/mkcert).
+Localhost ssl: Generate Self-signed SSL Certificate with guide [mkcert repository](https://github.com/FiloSottile/mkcert).
 
 ```
 docker compose up -d
@@ -175,7 +235,7 @@ The containers are now built and running. You should be able to access the Larav
 
 For convenience you may add a new entry into your hosts file.
 
-## Portainer
+### Portainer
 
 ```
 docker compose -f portainer-docker-compose.yml -p portainer up -d 
@@ -185,91 +245,73 @@ manage docker with [Portainer](https://www.portainer.io/) is the definitive cont
 
 You can also visit `https://example.com:9001` to access portainer after starting the containers.
 
-## Usage
+### Usage
 
 #### You could manage docker containers without command line with portainer.
 
-### Show both running and stopped containers
-
-The docker ps command only shows running containers by default. To see all containers, use the -a (or --all) flag:
+#### Here’s a quick reference of commonly used Docker Compose commands
 
 ```
-docker ps -a
+docker ps -a	# Lists all containers managed by the compose file
 ```
 
-### Starting containers
-
-You can start the containers with the `up` command in daemon mode (by adding `-d` as an argument) or by using the `start` command:
-
 ```
-docker compose start
+docker compose start	# Starts previously stopped containers
 ```
 
-### Stopping containers
-
 ```
-docker compose stop
+docker compose stop	# Stops all running containers
 ```
 
-### Removing containers
-
-To stop and remove all the containers use the `down` command:
-
 ```
-docker compose down
+docker compose down	# Stops and removes containers, networks, etc.
 ```
 
-to remove portainer and the other containers:
-
 ```
-docker rm -f $(docker ps -a -q)
+docker compose down -v # Add --volumes to remove volumes explicitly
 ```
 
-Use `-v` if you need to remove the database volume which is used to persist the database:
-
 ```
-docker compose down -v
+docker rm -f $(docker ps -a -q)	# Removes portainer and the other containers
 ```
 
-to remove external certbot-etc and portainer and the other volumes:
-
 ```
-docker volume rm $(docker volume ls -q)
+docker volume rm $(docker volume ls -q)	# Removes all volumes
 ```
 
-Delete all images, containers, volumes, and networks that are not associated with a container (dangling):
-
 ```
-docker system prune
+docker network prune	# Remove all unused networks
 ```
 
-To additionally remove any stopped containers and all unused images (not just dangling ones), add the -a flag to the command:
+```
+docker system prune	# Removes unused data (containers, networks, images, and optionally volumes)
+```
 
 ```
-docker system prune -a
+docker system prune -a	# Removes all unused images, not just dangling ones
 ```
 
-to remove portainer and the other images:
+```
+docker rmi $(docker image ls -q)	# Removes portainer and the other images
+```
 
 ```
-docker rmi $(docker image ls -q)
+docker container logs container_name_or_id	# Shows logs from all services
 ```
 
-### Project from existing source
+#### Project from existing source
 
 Copy all files into a new directory:
 
-You can now use the `up` command:
-
 ```
-docker compose up -d
+docker compose up -d	# Starts services in detached mode (in the background)
 ```
 
-### Docker run reference
+#### Docker run reference
 
-[https://docs.docker.com/engine/reference/run/](https://docs.docker.com/engine/reference/run/)
+[https://docs.docker.com/reference/cli/docker/compose/](https://docs.docker.com/reference/cli/docker/compose/)
 
-### Website
+#### Website
 
 You should see the "Laravel" page in your browser. If not, please check if your PHP installation satisfies Laravel's requirements.
 
@@ -291,7 +333,7 @@ docker container restart laravel
 
 Many important configuration values are defined using the ```./laravel/.env``` file that exists at the root of your application.
 
-[https://laravel.com/docs/9.x#environment-based-configuration](https://laravel.com/docs/9.x#environment-based-configuration)
+[https://laravel.com/docs/12.x/installation#environment-based-configuration](https://laravel.com/docs/12.x/installation#environment-based-configuration)
 
 add and/or remove laravel site folders and files with any ftp client program in ```./laravel``` folder.
 <br />You can also visit `https://example.com` to access website after starting the containers.
@@ -306,25 +348,25 @@ add or remove code in the ```./webserver/extra/httpd-ssl.conf``` file for custom
 
 The configuration for Laravel's database services is located in your application's config/database.php configuration file.
 
-[https://laravel.com/docs/9.x/database](https://laravel.com/docs/9.x/database)
+[https://laravel.com/docs/12.x/database](https://laravel.com/docs/12.x/database)
 
 [https://mariadb.com/kb/en/configuring-mariadb-with-option-files/](https://mariadb.com/kb/en/configuring-mariadb-with-option-files/)
 
-[https://dev.mysql.com/doc/refman/8.3/en/](https://dev.mysql.com/doc/refman/8.3/en/)
+[https://dev.mysql.com/doc/](https://dev.mysql.com/doc/)
 
 #### Redis
 
 You may configure your application's Redis settings via the config/database.php configuration file.
 
-[https://laravel.com/docs/9.x/redis](https://laravel.com/docs/9.x/redis)
+[https://laravel.com/docs/12.x/redis](https://laravel.com/docs/12.x/redis)
 
 #### Cache
 
 Your application's cache configuration file is located at config/cache.php.
 
-[https://laravel.com/docs/9.x/cache#main-content](https://laravel.com/docs/9.x/cache#main-content)
+[https://laravel.com/docs/12.x/cache](https://laravel.com/docs/12.x/cache)
 
-### phpMyAdmin
+#### phpMyAdmin
 
 You can add your own custom config.inc.php settings (such as Configuration Storage setup) by creating a file named config.user.inc.php with the various user defined settings in it, and then linking it into the container using:
 
@@ -336,10 +378,10 @@ You can also visit `https://example.com:9090` to access phpMyAdmin after startin
 
 The first authorize screen(htpasswd;username or password) and phpmyadmin login screen the username and the password is the same as supplied in the `.env` file.
 
-### backup
+#### backup
 
-This will back up the all files and folders in database/dump sql and html volumes, once per day, and write it to ./backups with a filename like backup-2023-01-01T10-18-00.tar.gz
+This will back up the all files and folders in database/dump sql and html volumes, once per day, and write it to ```./backups``` with a filename like backup-2023-01-01T10-18-00.tar.gz
 
-#### can run on a custom cron schedule
+##### can run on a custom cron schedule
 
 ```BACKUP_CRON_EXPRESSION: '20 01 * * *'``` the UTC timezone.