cslant / lemp-docker

:whale: This is a simple Docker Compose workflow that sets up a LEMP network of containers for local development. This also allows customizing the optional PHP version :elephant:

Welcome to Docker Config for LEMP Network

🐳 This is a simple Docker Compose workflow that sets up a LEMP network with PHP, Nginx, MariaDB, etc.

This configuration can be used for any PHP project (Laravel, Yii, CodeIgniter, Pure PHP, etc.) 🎉

Table of Contents

• Configuration requirements
• Add your custom bash script to run docker
• Installation and Setup
• Check the network ID and connect Database

Other docker configs: LAMP Stack (Apache, PHP, MariaDB, Redis) 🐳

Configuration requirements

To use the fpm image, you need an additional web server, such as Nginx, that can proxy HTTP-request to the fpm-port of the container. For fpm connection, this container exposes port 9000.

• Multi-site integration
• PHP optional version with custom in .env file (example: 7.4, 8.0, 8.1, 8.2, etc.)
• Web-server: Nginx
• DBMS (database management system): Mariadb
• In-memory database: Redis
• SSL Certificate (using mkcert)

Add your custom bash script to run the docker

Because maybe my configuration is not enough for the configuration required by your project or purpose, you need to add more configuration to the docker.

With nature of allowing you to customize the PHP version according to your. We should also allow custom bash scripts to run when starting the docker.

So, you can add your custom bash script to run docker in the file docker/bash/custom.sh with the following steps:

1. Create a file docker/bash/custom.sh:

Run:

cd docker/bash
cp custom.sh.example custom.sh

2. Add your custom bash script to run the docker

Then, you can add your custom bash script to run docker in the file docker/bash/custom.sh.

For example, you want to install ngrok extension for your docker container:

#!/bin/bash

# Install ngrok
snap install ngrok

# Install ngrok for php
docker-php-ext-install ngrok

# You can install other extensions here
# docker-php-ext-install <extension_name>

# etc.
npm install -g localtunnel

And now, just follow the steps below and run the docker.

Installation and Setup

Warning: If you don't want to use SSL, you can skip steps 1 and 2 and edit conf files in docker/config/conf.d/*.conf to remove the SSL configuration.

Please remove the 443 port in docker/config/conf.d/*.conf file and use 80 port for HTTP:

server {
    listen 80;
    server_name laravel-demo-site.com;
    root /var/www/laravel-demo/public;
    index index.php index.html index.htm;

    access_log /var/log/nginx/laravel-demo.access.log;
    error_log /var/log/nginx/laravel-demo.error.log;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        try_files $uri =404;
        fastcgi_pass php:9000;
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }
}

If you want to use SSL, please ignore the above warning and follow all the steps below.

1. Install SSL certificate

Using mkcert to create ssl certificate

For Ubuntu

sudo apt install libnss3-tools

sudo wget https://github.com/FiloSottile/mkcert/releases/download/v1.4.3/mkcert-v1.4.3-linux-amd64 && \
sudo mv mkcert-v1.4.3-linux-amd64 mkcert && \
sudo chmod +x mkcert && \
sudo cp mkcert /usr/local/bin/

For Mac or Windows

Please check and install mkcert at: https://github.com/FiloSottile/mkcert

Now that the mkcert utility is installed, run the command below to generate and install your local CA:

mkcert -install

2. Create an SSL certificate for this project

Run:

cd docker/server/certs
mkcert demo-site.local
mkcert laravel-demo-site.com

3. Run to start the docker

docker-compose up -d

4. Modify .env on the Laravel source

PHP_VERSION_SELECTED=8.2 # Choose the PHP version for your project

APP_NAME=lemp-stack # name of your docker project
APP_PORT=91 # port for docker server (apache)
SSL_PORT=448 # port for docker server (apache) with SSL
DB_PORT=13393 # port for the database (MariaDB)

MYSQL_ROOT_PASS=root
MYSQL_USER=root
MYSQL_PASS=root
MYSQL_DB=default-db # name of your database

PHPMYADMIN_PORT=9018 # port for phpmyadmin (database admin)
PHPMYADMIN_UPLOAD_LIMIT=1024M # set upload limit for phpmyadmin
IP_DB_SERVER=127.0.0.1

REDIS_PORT=16379 # port for Redis (in-memory database)

Check the network ID and connect the Database

1. Check CONTAINER ID

• Run docker ps to check the Container ID of APP_NAME-db
• Run the command docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' <container ID>

docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' <container_ID>

2. Connect to Database

Use the IP address to connect to the database using the database management system (DBMS) of your choice. For example, using MySQL Workbench:

You can also connect to the database using the DB_PORT in the .env file

For example, using MySQL Workbench: DB_PORT=13398

This is the demo of the result:

Add database for the second project (When using multiple sites)

What was instructed above can only be applied and created a database for default-db

For laravel-demo-site.com to work, you need to create a new database for it.

Please add a new database for laravel-demo-site.com with the phpmyadmin tool or any other tool you like. And then, please update DB_HOST on .env file to the new database of laravel-demo source.

Example: This configuration in laravel-demo source

DB_CONNECTION=mysql
DB_HOST=172.21.0.3 # IP address of APP_NAME-db
DB_PORT=3306
DB_DATABASE=laravel_demo # name of the database
DB_USERNAME=root
DB_PASSWORD=root

lemp-docker's Issues

Add default ports for docker-compose file

Currently, the ports and app names in the docker-compose file are being called directly from the environment variables in the .env file.

This is very detrimental because in some cases users do not pay attention to this configuration request and ignore it to proceed with running the build command.
In that case, it will cause an error because the ports are unknown.

So I need a condition that if the environment variables do not exist, I will get the default port to avoid the above error.

Update GitHub Actions to use Node.js 16 instead of Node.js 12

Warning:

Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: docker/setup-buildx-action@v1, docker/login-action@v1, docker/metadata-action@v3, docker/build-push-action@v2. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

I needed to update the compatible versions in the GitHub action to eliminate the above warning.

Change the configuration to set the latest PHP version

It's necessary to change the configuration so that the latest PHP version will automatically be selected as the default value, not the current 8.2 version.

build:
      context: .
      dockerfile: ./docker/Dockerfile
      args:
          - PHP_VERSION_SELECTED=${PHP_VERSION_SELECTED:-8.2}
          - PHP_VERSION=${PHP_VERSION_SELECTED:-8.2}

Create CI/CD pipeline docker action

Remove the demo source code of Laravel

Same as this issue, I think we don't need to show all the Laravel sources in config docker!

Optimize Dockerfile

We need to re-optimize the Dockerfile for the purpose of reducing layers, the number of processes.