full stack apache2 CakePHP for everyone with docker compose

If You want to build a website with CakePHP at short time;

Full stack Apache2 CakePHP:

                                                   

Plus, manage docker containers with Portainer.

Supported CPU architectures:

arm64/aarch64, x86-64

Supported Linux Package Manage Systems:

apk, dnf, yum, apt/apt-get, zypper, pacman

Supported Linux Operation Systems:

                               

Note: Fedora 37, 39 and alpine linux x86-64 compatible, could not try sles IBM Z s390x, rhel IBM Z s390x and raspberrypi.

With this project you can quickly run the following:

• CakePHP - php-fpm
• webserver (apache2/httpd)
• certbot (letsencrypt)
• phpMyAdmin
• Mariadb Mysql
• redis
• backup

For certbot (letsencrypt) certificate:

• Set DNS configuration of your domain name

IPv4/IPv6 Firewall

Create rules to open ports to the internet, or to a specific IPv4 address or range.

• http: 80
• https: 443
• portainer: 9001
• phpmyadmin: 9090

Contents:

• Auto Configuration and Installation
• Manual Configuration and Installation
  • Requirements
  • Configuration
  • Installation
• Portainer Installation
• Usage
  • Website
  • Webserver
  • Redis
  • DebugKit
  • phpMyAdmin
  • backup

Automatic

Exec install shell script for auto installation and configuration

download with

git clone https://github.com/damalis/full-stack-apache2-cakephp-for-everyone-with-docker-compose.git

Open a terminal and cd to the folder in which docker-compose.yml is saved and run:

cd full-stack-apache2-cakephp-for-everyone-with-docker-compose
chmod +x install.sh
./install.sh

Manual

Requirements

Make sure you have the latest versions of Docker and Docker Compose installed on your machine and require up to 2 GB of RAM.

• How install docker
• How install docker compose

Clone this repository or copy the files from this repository into a new folder.

Make sure to add your user to the docker group.

Configuration

download with

git clone https://github.com/damalis/full-stack-apache2-cakephp-for-everyone-with-docker-compose.git

Open a terminal and cd to the folder in which docker-compose.yml is saved and run:

cd full-stack-apache2-cakephp-for-everyone-with-docker-compose

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|PMA_HTPASSWD_PASSWORD|SSL_SNIPPET|

Variable	Value
LOCAL_TIMEZONE	to see local timezones
DIRECTORY_PATH	pwd at command line
DATABASE_IMAGE_NAME	mariadb or mysql
DATABASE_CONT_NAME	mariadb, mysql or custom name
DATABASE_PACKAGE_MANAGER	mariadb	apt-get update && apt-get install -y gettext-base
	mysql	microdnf install -y gettext
DATABASE_ADMIN_COMMANDLINE	mariadb	mariadb-admin
	mysql	mysqladmin
SSL_SNIPPET	localhost	echo 'Generated Self-signed SSL Certificate at localhost'
	remotehost	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}

and

cp ./webserver/extra/httpd-ssl.conf.template ./webserver/extra/httpd-ssl.conf

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

Firstly: will create external volume

docker volume create --driver local --opt type=none --opt device=${PWD}/certbot --opt o=bind certbot-etc

Localhost ssl: Generate Self-signed SSL Certificate with guide mkcert repository.

docker compose up -d	# Starts services in detached mode (in the background)

then

docker container restart webserver	# reloading for webserver ssl configuration

The containers are now built and running. You should be able to access the CakePHP installation with the configured IP in the browser address. https://example.com.

For convenience you may add a new entry into your hosts file.

Portainer

docker compose -f portainer-docker-compose.yml -p portainer up -d 

manage docker with Portainer is the definitive container management tool for Docker, Docker Swarm with it's highly intuitive GUI and API.

You can also visit https://example.com:9001 to access portainer after starting the containers.

Usage

You could manage docker containers without command line with portainer.

Here’s a quick reference of commonly used Docker Compose commands

docker ps -a	# Lists all containers managed by the compose file

docker compose start	# Starts previously stopped containers

docker compose stop	# Stops all running containers

docker compose down	# Stops and removes containers, networks, etc.

docker compose down -v # Add --volumes to remove volumes explicitly

docker rm -f $(docker ps -a -q)	# Removes portainer and the other containers

docker volume rm $(docker volume ls -q)	# Removes all volumes

docker network prune	# Remove all unused networks

docker system prune	# Removes unused data (containers, networks, images, and optionally volumes)

docker system prune -a	# Removes all unused images, not just dangling ones

docker rmi $(docker image ls -q)	# Removes portainer and the other images

docker container logs container_name_or_id	# Shows logs from all services

Project from existing source

Copy all files into a new directory:

docker compose up -d	# Starts services in detached mode (in the background)

Docker run reference

https://docs.docker.com/reference/cli/docker/compose/

Website

You should see the "Welcome to CakePHP..." page in your browser. If not, please check if your PHP installation satisfies CakePHP's requirements.

https://example.com

add or remove code in the ./php-fpm/php/conf.d/security.ini file for custom php.ini configurations

https://www.php.net/manual/en/configuration.file.php

You should make changes custom host configurations ./php-fpm/php-fpm.d/z-www.conf then must restart service, FPM uses php.ini syntax for its configuration file - php-fpm.conf, and pool configuration files.

https://www.php.net/manual/en/install.fpm.configuration.php

docker container restart cakephp

add and/or remove cakephp site folders and files with any ftp client program in ./cakephp/webroot folder.
You can also visit https://example.com to access website after starting the containers.

Webserver

add or remove code in the ./webserver/extra/httpd-ssl.conf file for custom apache2/httpd configurations

https://httpd.apache.org/docs/2.4/

Redis

see Redis Cache options and must add below code to config file.

modify redis cache configuration values in the ./cakephp/config/app_local.php file.

	/**
	* Configure the cache adapters.
	*/
	'Cache' => [
		'default' => [
			'className' => 'Redis',
			'path' => CACHE,
			'password' => false,
			'server' => 'redis',
			'port' => 6379,
		],

		/**
		* Configure the cache used for general framework caching.
		* Translation cache files are stored with this configuration.
		*/
		'_cake_core_' => [
			'className' => 'Redis',
			'prefix' => 'myapp_cake_core_',
			'path' => CACHE . 'persistent/',
			'serialize' => true,
			'duration' => '+2 minutes',
			'server' => 'redis',
			'port' => 6379,
			'password' => false,
		],

		/**
		 * Configure the cache for model and datasource caches. This cache
		 * configuration is used to store schema descriptions, and table listings
		 * in connections.
		 */
		'_cake_model_' => [
			'className' => 'Redis',
			'prefix' => 'myapp_cake_model_',
			'path' => CACHE . 'models/',
			'serialize' => true,
			'duration' => '+2 minutes',
			'server' => 'redis',
			'port' => 6379,
			'password' => false,
		],
	],

DebugKit

book.cakephp.org/debugkit/5/en/index.html#configuration

If debugkit not showing and get error "This request has been blocked; the content must be served over HTTPS"

add code snippet <meta http-equiv="Content-Security-Policy" content="upgrade-insecure-requests"> in the ./cakephp/templates/Pages/home.php file.

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:

./phpmyadmin/config.user.inc.php

You can also visit https://example.com:9090 to access phpMyAdmin after starting the containers.

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

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

BACKUP_CRON_EXPRESSION: '20 01 * * *' the UTC timezone.