Documentation: Install PrestaShop

docs/_includes/links/examples.rst

@@ -40,6 +40,12 @@
      Official Photon CMS Documentation <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
    </a>
 
+.. |ext_lnk_example_presta_shop| raw:: html
+
+   <a target="_blank" href="http://doc.prestashop.com/display/PS17/Getting+started">
+     Official PrestaShop Documentation <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
+   </a>
+
 .. |ext_lnk_example_shopware_documentation| raw:: html
 
    <a target="_blank" href="https://en-community.shopware.com/Shopware-5-Installer_detail_1351_730.html/sCoreId,bdd630e6d079964f3f697fccff83a987">

docs/examples/setup-presta-shop.rst

@@ -0,0 +1,183 @@
+.. include:: /_includes/all.rst
+
+.. _example_setup_presta_shop:
+
+****************
+Setup PrestaShop
+****************
+
+This example will use ``git`` and ``composer`` to install PrestaShop from within the Devilbox
+PHP container.
+
+After completing the below listed steps, you will have a working PrestaShop setup ready to be
+served via http and https.
+
+.. seealso:: |ext_lnk_example_presta_shop|
+
+
+**Table of Contents**
+
+.. contents:: :local:
+
+
+Overview
+========
+
+The following configuration will be used:
+
++--------------+--------------------------+-------------+------------+-------------------------------------------------+
+| Project name | VirtualHost directory    | Database    | TLD_SUFFIX | Project URL                                     |
++==============+==========================+=============+============+=================================================+
+| my-presta    | /shared/httpd/my-presta  | my_presta   | loc        | http://my-presta.loc |br| https://my-presta.loc |
++--------------+--------------------------+-------------+------------+-------------------------------------------------+
+
+.. note::
+   * Inside the Devilbox PHP container, projects are always in ``/shared/httpd/``.
+   * On your host operating system, projects are by default in ``./data/www/`` inside the
+     Devilbox git directory. This path can be changed via :ref:`env_httpd_datadir`.
+
+
+Walk through
+============
+
+It will be ready in eight simple steps:
+
+1. Enter the PHP container
+2. Create a new VirtualHost directory
+3. Install PrestaShop via ``git`` and ``composer``
+4. Symlink webroot directory
+5. Add MySQL database
+6. Configure datbase connection
+7. Setup DNS record
+8. Visit http://my-presta.loc in your browser
+
+
+1. Enter the PHP container
+--------------------------
+
+All work will be done inside the PHP container as it provides you with all required command line
+tools.
+
+Navigate to the Devilbox git directory and execute ``shell.sh`` (or ``shell.bat`` on Windows) to
+enter the running PHP container.
+
+.. code-block:: bash
+
+   host> ./shell.sh
+
+.. seealso::
+   * :ref:`enter_the_php_container`
+   * :ref:`work_inside_the_php_container`
+   * :ref:`available_tools`
+
+
+2. Create new vhost directory
+-----------------------------
+
+The vhost directory defines the name under which your project will be available. |br|
+( ``<vhost dir>.TLD_SUFFIX`` will be the final URL ).
+
+.. code-block:: bash
+
+   devilbox@php-7.0.20 in /shared/httpd $ mkdir my-presta
+
+.. seealso:: :ref:`env_tld_suffix`
+
+
+3. Install PrestaShop
+---------------------
+
+Navigate into your newly created vhost directory and install PrestaShop with ``git`` and ``composer``.
+
+.. code-block:: bash
+
+   devilbox@php-7.0.20 in /shared/httpd $ cd my-presta
+
+   # Download PrestaShop with git
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ git clone https://github.com/PrestaShop/PrestaShop
+
+   # Checkout the latest stable git tag
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ cd PrestaShop
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ git checkout 1.7.4.2
+
+   # Install dependencies with Composer
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ composer install
+
+How does the directory structure look after installation:
+
+.. code-block:: bash
+
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ tree -L 1
+   .
+   └── PrestaShop
+
+   1 directory, 0 files
+
+
+4. Symlink webroot
+------------------
+
+Symlinking the actual webroot directory to ``htdocs`` is important. The web server expects every
+project's document root to be in ``<vhost dir>/htdocs/``. This is the path where it will serve
+the files. This is also the path where your frameworks entrypoint (usually ``index.php``) should
+be found.
+
+Some frameworks however provide its actual content in nested directories of unknown levels.
+This would be impossible to figure out by the web server, so you manually have to symlink it back
+to its expected path.
+
+.. code-block:: bash
+
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ ln -s PrestaShop/ htdocs
+
+How does the directory structure look after symlinking:
+
+.. code-block:: bash
+
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ tree -L 1
+   .
+   ├── PrestaShop
+   └── htdocs -> PrestaShop
+
+   2 directories, 0 files
+
+As you can see from the above directory structure, ``htdocs`` is available in its expected
+path and points to the frameworks entrypoint.
+
+
+5. Add MySQL Database
+---------------------
+
+.. code-block:: bash
+
+   devilbox@php-7.0.20 in /shared/httpd/my-presta $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_presta;'
+
+
+6. DNS record
+-------------
+
+If you **have** Auto DNS configured already, you can skip this section, because DNS entries will
+be available automatically by the bundled DNS server.
+
+If you **don't have** Auto DNS configured, you will need to add the following line to your
+host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc`` on Windows):
+
+.. code-block:: bash
+   :caption: /etc/hosts
+
+   127.0.0.1 my-presta.loc
+
+.. seealso::
+
+   * :ref:`howto_add_project_hosts_entry_on_mac`
+   * :ref:`howto_add_project_hosts_entry_on_win`
+   * :ref:`setup_auto_dns`
+
+
+7. Open your browser
+--------------------
+
+All set now, you can visit http://my-presta.loc or https://my-presta.loc in your browser and
+follow the installation steps.
+
+.. seealso:: :ref:`setup_valid_https`

docs/getting-started/create-your-first-project.rst

@@ -201,6 +201,7 @@ their articles:
    * :ref:`example_setup_laravel`
    * :ref:`example_setup_phalcon`
    * :ref:`example_setup_photon_cms`
+   * :ref:`example_setup_presta_shop`
    * :ref:`example_setup_shopware`
    * :ref:`example_setup_symfony`
    * :ref:`example_setup_typo3`

docs/index.rst

@@ -144,6 +144,7 @@ host is ready to be served with your custom domain.
    examples/setup-laravel
    examples/setup-phalcon
    examples/setup-photon-cms
+   examples/setup-presta-shop
    examples/setup-shopware
    examples/setup-symfony
    examples/setup-typo3

docs/support/faq.rst

@@ -189,6 +189,12 @@ Does it work with Photon CMS?
 Yes, see :ref:`example_setup_photon_cms`
 
 
+Does it work with PrestaShop?
+-----------------------------
+
+Yes, see :ref:`example_setup_presta_shop`
+
+
 Does it work with Shopware?
 ---------------------------