Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/damalis/full-stack-proxy-nginx-magento-for-everyone-with-docker-compose

If You want to build a reverse proxy website with Magento at short time; install full stack proxy nginx Magento with Docker Compose. Plus, manage docker containers with Portainer, and even secure your site with SSL.
https://github.com/damalis/full-stack-proxy-nginx-magento-for-everyone-with-docker-compose

ecommerce ecommerce-application ecommerce-framework ecommerce-platform ecommerce-shopping-solution ecommerce-store ecommerce-website full-stack-ecommerce hacktoberfest magento magento2

Last synced: 5 months ago
JSON representation

If You want to build a reverse proxy website with Magento at short time; install full stack proxy nginx Magento with Docker Compose. Plus, manage docker containers with Portainer, and even secure your site with SSL.

Awesome Lists containing this project

README 

          
# [full stack proxy nginx Magento for everyone with docker compose](https://github.com/damalis/full-stack-proxy-nginx-magento-for-everyone-with-docker-compose)



If You want to build a reverse proxy website with Magento at short time;



#### Full stack Proxy Nginx Magento:



 Magento     

 docker     

 mariadb     

 mysql     

 nginx     

 apache2     

 php     

 valkey     

 varnish     

 opensearch    

 Bash     

 mailhog     

 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/dpkg, zypper, pacman 



#### Supported Linux Distributions:

 centos, debian, fedora, raspbian, rhel, sles, static, ubuntu 


 

#### Supported Linux Operation Systems:



 alpine linux     

 fedora     

 centos     

 debian     

 ubuntu     

 ubuntu     

 redhat on s390x (IBM Z)     

 opensuse on s390x (IBM Z)     

 arch linux 




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

##### After installing the repository, a system reboot is required on Red Hat OS, Arch Linux.



#### With this project you can quickly run the following:



- [Magento](https://github.com/magento) - [php-fpm](https://hub.docker.com/_/php?tab=tags&page=1&name=fpm)

- [webserver (apache2/httpd)](https://hub.docker.com/_/httpd)

- [proxy (nginx)](https://hub.docker.com/_/nginx)

- [certbot (letsencrypt)](https://hub.docker.com/r/certbot/certbot)

- [phpMyAdmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/)

- [Mariadb](https://hub.docker.com/_/mariadb) [Mysql](https://hub.docker.com/_/mysql)

- [valkey](https://hub.docker.com/r/valkey/valkey)

- [varnish](https://hub.docker.com/_/varnish)

- [opensearch](https://hub.docker.com/r/opensearchproject/opensearch)

- [mailhog](https://github.com/mailhog)

- [backup](https://hub.docker.com/r/offen/docker-volume-backup)



#### For certbot (letsencrypt) certificate:



- [Set DNS configuration of your domain name](https://support.google.com/a/answer/48090?hl=en)



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



#### Magento authentication keys



The repo.magento.com repository is where Adobe Commerce and Magento Open Source and third-party Composer packages are stored and requires authentication.

Use your Commerce Marketplace account to generate a pair of 32-character authentication keys to access the repository



Get your authentication keys: [https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/prerequisites/authentication-keys.html?lang=en](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/prerequisites/authentication-keys.html?lang=en)



#### How you set vm.max_map_count depends on your platform



The following requirements and recommendations apply when running Opensearch in Docker in production.



[https://opensearch.org/blog/error-logs/error-log-max-virtual-memory-areas-vm-max_map_count-is-too-low/](https://opensearch.org/blog/error-logs/error-log-max-virtual-memory-areas-vm-max_map_count-is-too-low/)



#### 4 GB RAM (8 GB recommended) and CPU 2 cores (2 GHz each) (4 cores (2 GHz or more each) recommended)



Upgrading the applications and extensions you obtain from the Commerce Marketplace and other sources can require up to 4 GB of RAM. If you are using a system with less than 4 GB of RAM, we recommend you create a [swap file](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-20-04); otherwise, your install might fail.



#### Contents:



- [Auto Configuration and Installation](#automatic)

- [Manual Configuration and Installation](#manual)

	- [Requirements](#requirements)

	- [Configuration](#configuration)

	- [Installation](#installation)

- [Portainer Installation](#portainer)

- [Usage](#usage)

	- [Website](#website)

	- [Proxy](#proxy)

	- [Webserver](#webserver)

	- [Database](#database)

	- [Valkey](#valkey)

	- [Varnish](#varnish)

	- [Opensearch](#opensearch)

	- [Mail](#mail)

	- [phpMyAdmin](#phpmyadmin)

	- [backup](#backup)



### Automatic



#### Exec install shell script for auto installation and configuration



download with



```

git clone https://github.com/damalis/full-stack-proxy-nginx-magento-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-proxy-nginx-magento-for-everyone-with-docker-compose

chmod +x install.sh

sudo LC_ALL=C.UTF-8 ./install.sh # LC_ALL=C.UTF-8 if not os language english

```



### Manual



#### Requirements



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



- [How install docker](https://docs.docker.com/engine/install/)

- [How install docker compose](https://docs.docker.com/compose/install/)



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).



#### Configuration



download with



```

git clone https://github.com/damalis/full-stack-proxy-nginx-magento-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-proxy-nginx-magento-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_VERSION```|```DATABASE_PACKAGE_MANAGER```|```DATABASE_ADMIN_COMMANDLINE```|```PMA_CONTROLUSER```|```PMA_CONTROLPASS```|

|```PMA_HTPASSWD_USERNAME```|```PMA_HTPASSWD_PASSWORD```|```VARNISH_VERSION```|```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_VERSION

    mariadb

    11.4.7

  

  

    mysql

    8.4

  

  

    DATABASE_PACKAGE_MANAGER

    mariadb

    apt-get update && apt-get install -y gettext-base

  

  

    mysql

    microdnf update -y && microdnf install -y gettext

  

  

    DATABASE_ADMIN_COMMANDLINE

    mariadb

    mariadb-admin

  

  

    mysql

    mysqladmin

  

  

    VARNISH_VERSION

    centos version 9+ and fedora

    latest

  

  

    the others

    stable

  

  

    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} -d mail.${DOMAIN_NAME}

  



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

```



Localhost ssl: Generate Self-signed SSL Certificate with guide [mkcert repository](https://github.com/FiloSottile/mkcert).



```

docker compose up -d

```



then reloading for proxy ssl configuration



```

docker container restart proxy

```



The containers are now built and running. You should be able to access the Magento 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](https://www.portainer.io/) 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/](https://docs.docker.com/reference/cli/docker/compose/)



#### Website



You should see the "Luma..." page in your browser. If not, please check if your PHP installation satisfies Magento's requirements or ```docker container restart varnish```



```

https://example.com

```



How to retrieve admin URI?



You can get it from ```./magento/app/etc/env.php``` file,



You have to get frontname from this file and suffix in your base url.



```

'backend' => 

  array (

    'frontName' => 'admin',

  ),

```



Or



```

bin/magento info:adminuri

```



```

Username: admin

Password: admin123

```



#### How to Disable 2F Authentication in Magento?



exec 

```

bin/magento module:disable {Magento_AdminAdobeImsTwoFactorAuth,Magento_TwoFactorAuth} --clear-static-content

bin/magento setup:di:compile

bin/magento setup:static-content:deploy -f

bin/magento indexer:reindex

bin/magento cache:flush

bin/magento setup:upgrade

```

in magento container.



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](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](https://www.php.net/manual/en/install.fpm.configuration.php)



```

docker container restart magento

```



add and/or remove magento site folders and files with any ftp client program in ```./magento``` folder.


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



#### Proxy



Proxying is typically used to distribute the load among several servers, seamlessly show content from different websites, or pass requests for processing to application servers over protocols other than HTTP.



add or remove code in the ```./proxy/templates/proxy.conf.template``` file for custom proxy configurations



[https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/)



#### Webserver



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



[https://httpd.apache.org/docs/2.4/](https://httpd.apache.org/docs/2.4/)



#### 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/](https://dev.mysql.com/doc/)



#### Valkey



you can usually find your Valkey configuration in the following file: ```./valkey/valkey.conf```

To optimize the Valkey instance for your requirements, you get best results by using a dedicated instance for each session, Commerce cache and FPC.



[https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cache/redis/config-redis.html?lang=en](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cache/redis/config-redis.html?lang=en)



#### Varnish



Configure Varnish: [https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cache/varnish/config-varnish.html?lang=en](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cache/varnish/config-varnish.html?lang=en)



after every change in the Magento and the varnish configuration or if You get error "502 Bad Gateway":



```

docker container restart varnish

```



#### Opensearch



Magento Open Source 2.4; installations must be configured to use Opensearch.



[https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/search/configure-search-engine.html?lang=en](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/search/configure-search-engine.html?lang=en)



#### Mail



SMTP settings: |```Host: mail, Port: 1025```|



The authorize screen, ```username: ${PMA_HTPASSWD_USERNAME}``` and ```password: ${PMA_HTPASSWD_PASSWORD}``` in the `.env` 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.