presta-deploy is a dev deployment environment for Prestashop project

This project is used to encapsulate prestashop in a convenient environment.

Thanks to it, it should be easy to deploy a dev, demo, test, ... environment and to use it.

Thereby, presta-deploy manages environment, setup and dependencies questions for Prestashop purpose.

Requirements

In order to use this project on your environment, you need

• Docker Engine
• Docker-compose
• git
• make

Deployment

Local first install

1. For first install, pre-configure your environment
   1. cp infra/env/deploy.env.template infra/env/deploy.env
   2. Edit deploy.env values.
   3. make env-init
   4. Edit all required infra/env/data/${DEPLOY_ENV}/*.env values and customize what you want.
2. Then initialize your environment : infra-init

☝️ Connect to your install (take PROXY_BASE_HOSTNAME from PROXY_BASE_HOSTNAME_LIST):

• auto-setup : https://{PROXY_BASE_HOSTNAME}/install-dev/index.php
• front-office : https://{PROXY_BASE_HOSTNAME}/index.php
• back-office : https://{PROXY_BASE_HOSTNAME}/admin-dev/index.php

☝️ Take a look to Makefile commands. Usefull to understand Prestashop install/deployment.

☝️ Please notice that presta-deploy uses git submodules.

☝️ If you configured custom host with PROXY_BASE_HOSTNAME_LIST, you may want to edit your hosts file.

Emailing configuration

If you need to test Prestashop emailing, you can configure a local SMTP server with make psh-dev-configure-smtp command.

Then you can access it over http://localhost:8080/#/.

☝️ Your ${DOCKER_COMPOSE} variable requires to integrate SMTP service configuration (ie. -f ${INFRA_DOCKER_PATH}/smtp.docker-compose.yaml)

You can use another SMTP server. This example helps you to configure a Gmail SMTP server : Example of Gmail smtp server configuration :

1. Generate an app password in Gmail

   Useful documentation :

   • Create an App Password for gmail
   • Generate app password for Gmail inbox
   • access for lesser app

2. Edit your SMTP configuration (${INFRA_ENV_PATH}/smtp.env) :

• SMTP server : smtp.gmail.com
• SMTP username : {your gmail email}
• SMTP password : {app password you previously generated}
• SMTP encryption : tls or ssl
• SMTP port : 587 (for tls) or 465 (for ssl)

3. re run make psh-dev-configure-smtp command

⚠️ It looks that encryption value may suffer some cache problem if you set it with makefile command.

Reset your full environment (including Docker)

1. make env-reset
2. cd src/prestashop {change your prestashop version, exemple : git checkout 1.7.8.x}
3. make infra-init

☝️ This won't change your *.env configurations

Reset your shop data

1. psh-dev-reinstall

Reset your shop data after a major version change (requires to rebuild assets et clean modules)

1. make psh-dev-reinstall-with-assets

Docker usage

TODO

• build / login / deploy
• environment variables
• Docker registry

Development

Contributing

If you want to use this project for Prestashop organization projects contribution, please start reading official guidelines :

• Contributing
• Contribution guidelines
• Coding Standards
• Submitting code changes
• Writing a good commit message
• Create a pull request

Once you are aware about Prestashop expectations, you may want to adapt your git configuration to push your local modifications to your own forks. Please take a look at Development setup

Usefull documentation

☝️ Please notice that you can find some internal documentation under doc/ directory of this repository.

• Docker development best practices
• Docker-compose reference
• Install Docker Engine
• Install Docker Compose

Dev and stack documentation

• How To Debug PHP using Xdebug, VS Code and Docker

Contribute to a Prestashop module

The command make psh-dev-reinstall-with-sources is made to load modules keeping .git then you can work and test modules inside Prestashop directly.

⚠️ Be attentive to remote configuration to sync with your fork.

Todo

• Genericity and automation
  • Multi prestashop version management
    • Solve git flow with versionned submodules
      • Take a look at https://git-scm.com/docs/git-update-index#_skip_worktree_bit option

        ⚠️ Take a look at git version and submodule specific behaviors. This option may be tricky.

        ❓ Can I still work inside submodule project with this option ?

    • Add INFRA_SRC_PSH_BASE_BRANCH parameter to infra/env/deploy.env.template (default value defined in Makefile : develop)
      • Create src/prestashop/{INFRA_SRC_PSH_BASE_BRANCH} submodules
      • update INFRA_SRC_PSH and INFRA_ENV_PATH with INFRA_SRC_PSH_BASE_BRANCH
    • Branch naming convention
      • Convention : {INFRA_SRC_PSH_BASE_BRANCH}/{type}/{issue #}/{specific_label}
      • Create a dedicated command (script ?) psh-dev-prepare-branch

        cd $INFRA_SRC_PSH
        git diff --exit-code
        git checkout {INFRA_SRC_PSH_BASE_BRANCH}
        git fetch ...; git rebase; # should we force push {INFRA_SRC_PSH_BASE_BRANCH} ?
        # Add a script to define new branch name (product/bugfix/feature/tmp/... type, issue # and specific label)
        git checkout -b {new_branch_name}

    • Organize project with source version dependant scripts (install / update / backup / ...) may change with versions.
  • Rename all containers name to be project dependant (I want to be able install several instances of the project on my PC) => review env-docker-clean command to clean only project docker objects.
  • Enhance fixtures management
    • Prestashop backup / restore commands
    • Allow init with data (tests / demo / dev / ...)
      • https://forums.docker.com/t/we-cant-push-a-docker-volume-so-now-what/56160
  • Add a warning to env commands (Y/n option)
  • Add php, node and mysql version to project variables (deploy.env)
    • Create php version dedicated Dockerfiles.
• Optimisation and project architecture
  • Check psh-clean-cache command (it looks it breaks something, does it ?)
  • Create a dedicated Docker image for all dev tools : composer / node / gh / phpmyadmin
    • https://github.com/trussworks/docker-gh/blob/master/Dockerfile#L44-L48
    • ☝️ prestashop cli commands should be run from psh.app
    • Should node version be configurable as well ? 🤔
  • Script / command refactoring & enhancement
    • Take a look at https://github.com/jolelievre/ps-install-tools
    • Take a look at https://github.com/SD1982/dockerQA
    • Take a look at src/prestashop/.github for CI actions / commands
  • [/] Add SMTP management
    • create a MailDEv container https://github.com/maildev/maildev
    • sync maildev & prestashop
    • manage smtp configuration by dedicated variables.
    • Find a way to reset applicativ cache after make psh-dev-configure-smtp command (due to encryption cache problem)
  • Add some cache for phpstan and php_cs dev usage (specific reset for "env cache" and not reset during psh-dev-reset)
  • [/] Add node/npm cache persistent volume (It looks the used volume isn't enough)
    • We may enhance "reinstall" process using this trick : https://github.com/jolelievre/ps-install-tools/blob/master/tools/tools.sh#L120-L150
  • Docker images build
    • [/] Take a look at multi-stage builds. Use docker-compose build section with context, target, args doc : https://docs.docker.com/develop/develop-images/multistage-build/ https://docs.docker.com/compose/compose-file/build/ example : https://stackoverflow.com/questions/36362233/can-a-dockerfile-extend-another-one
    • Consider new multiple build context docker feature doc : https://www.docker.com/blog/dockerfiles-now-support-multiple-build-contexts/
    • naming depending on php version, OS, etc.
    • Create a deploy.env variable for php base image tag
    • Create dedicated "composer" image for composer commands ?
      • Take a look at some tools
        • https://github.com/nenes25/prestashop_console
        • https://github.com/friends-of-presta/fop_console
  • Study BindFS configuration for right management. https://www.fullstaq.com/knowledge-hub/blogs/docker-and-the-host-filesystem-owner-matching-problem
• Prestashop sources
  • Clean Prestashop src to ensure dedicated directories for install
    • Remove those directories from root source repository :
      • admin-dev/autoupgrade app/config app/logs app/Resources/translations cache config download img log mails modules override themes translations upload var
• Documentation and assets
  • Consider adding prestashop devdoc to ./doc/prestashop (cf. https://github.com/PrestaShop/devdocs-site/blob/main/.gitmodules)
  • Add proxy configuration documentation (infra/env/data/${DEPLOY_ENV}/proxy.env and infra/env/data/${DEPLOY_ENV}/proxy/etc/nginx specific behavior)
• Proxy
  • Create timeout parameter to overwrite infra/env/template/proxy/etc/nginx/vhost.d/prestashop.proxy (take a look to php.ini as well)