/full-stack-apache2-fat-free-for-everyone-with-docker-compose

If You want to build a website with Fat-Free at short time; install full stack apache2 Fat-Free with Docker Compose. Plus, manage docker containers with Portainer.

Primary LanguageShell

If You want to build a website with Fat-Free at short time;

Full stack Apache2 Fat-Free:

Fat-Free     docker     mariadb     mysql     apache2     php     redis     Bash     phpmyadmin     certbot     letsencrypt     portainer     backup

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

Supported Linux Operation Systems:

alpine linux     fedora     centos     debian     ubuntu     ubuntu     redhat on s390x (IBM Z)     opensuse on s390x (IBM Z)

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:

For certbot (letsencrypt) certificate:

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:

Automatic

Exec install shell script for auto installation and configuration

download with

git clone https://github.com/damalis/full-stack-apache2-fat-free-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-fat-free-for-everyone-with-docker-compose
chmod +x install.sh
./install.sh

Requirements

Make sure you have the latest versions of Docker and Docker Compose installed on your machine.

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

Make sure to add your user to the docker group.

Manual

Configuration

download with

git clone https://github.com/damalis/full-stack-apache2-fat-free-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-fat-free-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 and PMA_HTPASSWD_PASSWORD.

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=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

and

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
docker compose up -d

then reloading for webserver ssl configuration

docker container restart webserver

The containers are now built and running. You should be able to access the Fat-Free 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.

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:

docker ps -a

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

Stopping containers

docker compose stop

Removing containers

To stop and remove all the containers use the down command:

docker compose down

to remove portainer and the other containers:

docker rm -f $(docker ps -a -q)

Use -v if you need to remove the database volume which is used to persist the database:

docker compose down -v

to remove external certbot-etc and portainer and the other volumes:

docker volume rm $(docker volume ls -q)

Delete all images, containers, volumes, and networks that are not associated with a container (dangling):

docker system prune

To additionally remove any stopped containers and all unused images (not just dangling ones), add the -a flag to the command:

docker system prune -a

to remove portainer and the other images:

docker rmi $(docker image ls -q)

Project from existing source

Copy all files into a new directory:

You can now use the up command:

docker compose up -d

Docker run reference

https://docs.docker.com/engine/reference/run/

Website

You should see the "Hello, world!" page in your browser. If not, please check if your PHP installation satisfies Fat-Free'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 fat-free

add and/or remove fat-free site folders and files with any ftp client program in ./fat-free 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/

Database

$db=new DB\SQL(
    'mysql:host=database;port=3306;dbname=${DB_NAME}',
    '${DB_USER}',
    '${DB_PASSWORD}'
);

https://fatfreeframework.com/3.8/databases

https://mariadb.com/kb/en/configuring-mariadb-with-option-files/

https://dev.mysql.com/doc/refman/8.3/en/

Redis

There is a good Cache Engine User Guide that covers how the cache engine works and gives you tips to improve your application and your database queries, as they can be cached by F3 as well. You really should have read it.

Redis host = redis

Redis host port = 6379

https://fatfreeframework.com/3.8/cache

Cache

Caching static Web pages - so the code in some route handlers can be skipped and templates don't have to be reprocessed - is one way of reducing your Web server's work load so it can focus on other tasks.

https://fatfreeframework.com/3.8/optimization

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.