diff --git a/README.md b/README.md index 3f9a5b21..b9d97f06 100644 --- a/README.md +++ b/README.md @@ -521,6 +521,7 @@ As far as tested there are no limitations and you can use any Framework or CMS j Devilbox Devilbox +Devilbox Devilbox Devilbox Devilbox @@ -538,6 +539,7 @@ As far as tested there are no limitations and you can use any Framework or CMS j > **Documentation:**
> [Setup CakePHP](https://devilbox.readthedocs.io/en/latest/examples/setup-cakephp.html) | > [Setup CodeIgniter](https://devilbox.readthedocs.io/en/latest/examples/setup-codeigniter.html) | +> [Setup CraftCMS](https://devilbox.readthedocs.io/en/latest/examples/setup-craftcms.html) | > [Setup Drupal](https://devilbox.readthedocs.io/en/latest/examples/setup-drupal.html) | > [Setup Joomla](https://devilbox.readthedocs.io/en/latest/examples/setup-joomla.html) | > [Setup Laravel](https://devilbox.readthedocs.io/en/latest/examples/setup-laravel.html) | diff --git a/docs/_includes/links/examples.rst b/docs/_includes/links/examples.rst index 87726129..407e2eaa 100644 --- a/docs/_includes/links/examples.rst +++ b/docs/_includes/links/examples.rst @@ -10,6 +10,12 @@ Official CodeIgniter Documentation +.. |ext_lnk_example_craftcms_documentation| raw:: html + + + Official CraftCMS Documentation + + .. |ext_lnk_example_drupal_documentation| raw:: html diff --git a/docs/examples/setup-craftcms.rst b/docs/examples/setup-craftcms.rst new file mode 100644 index 00000000..56d90b34 --- /dev/null +++ b/docs/examples/setup-craftcms.rst @@ -0,0 +1,231 @@ +.. include:: /_includes/all.rst + +.. _example_setup_craftcms: + +************** +Setup CraftCMS +************** + +This example will use ``composer`` to install CraftCMS from within the Devilbox PHP container. + +After completing the below listed steps, you will have a working CraftCMS setup ready to be +served via http and https. + +.. seealso:: |ext_lnk_example_craftcms_documentation| + + +**Table of Contents** + +.. contents:: :local: + + +Overview +======== + +The following configuration will be used: + ++--------------+--------------------------+-------------+------------+-----------------------------------------------+ +| Project name | VirtualHost directory | Database | TLD_SUFFIX | Project URL | ++==============+==========================+=============+============+===============================================+ +| my-craft | /shared/httpd/my-craft | my_craft | loc | http://my-craft.loc |br| https://my-craft.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 CraftCMS via ``composer`` +4. Symlink webroot directory +5. Add MySQL database +6. Setup DNS record +7. Run setup wizard +8. Visit http://my-craft.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| +( ``.TLD_SUFFIX`` will be the final URL ). + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd $ mkdir my-craft + +.. seealso:: :ref:`env_tld_suffix` + + +3. Install CraftCMS +------------------- + +Navigate into your newly created vhost directory and install CraftCMS with ``composer``. + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd $ cd my-craft + devilbox@php-7.0.20 in /shared/httpd/my-craft $ composer create-project craftcms/craft craftcms + +How does the directory structure look after installation: + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd/my-craft $ tree -L 1 + . + └── craftcms + + 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 ``/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-craft $ ln -s craftcms/web/ htdocs + +How does the directory structure look after symlinking: + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd/my-craft $ tree -L 1 + . + ├── craftcms + └── htdocs -> craftcms/web + + 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-craft $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_craft CHARACTER SET utf8 COLLATE utf8_unicode_ci;' + + +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-craft.loc + +.. seealso:: + + * :ref:`howto_add_project_hosts_entry_on_mac` + * :ref:`howto_add_project_hosts_entry_on_win` + * :ref:`setup_auto_dns` + + +7. Run setup wizard +------------------- + +After everything is setup, you need to run the setup wizard. CraftCMS bundles a commandline tool +that you can use. + +7.1 Via command line tool +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd/my-craft $ php craftcms/craft setup + + Which database driver are you using? [mysql,pgsql,?]: mysql + Database server name or IP address: [localhost] 127.0.0.1 + Database port: [3306] + Database username: [root] + Database password: + Database name: my_craft + Database table prefix: + Testing database credentials... success! + Saving database credentials to your .env file... done + + Install Craft now? (yes|no) [yes]: + + Username: [admin] + Email: admin@devilbox.org + Password: + Confirm: + Site name: craftcms + Site URL: [@web] my-craft.loc + Site language: [en-US] + + ... + + *** installed Craft successfully (time: 14.660s) + + +7.2 Via browser +^^^^^^^^^^^^^^^ + +If you do not feel too comfortable on the command line, you can also run the setup wizard via +the browser. See their official documentation for screenshots. + +.. seealso:: |ext_lnk_example_craftcms_documentation| + +To open the setup wizard, visit: http://my-craft.loc/admin/install or https://my-craft.loc/admin/install + +* Driver: ``MySQL`` +* Server: ``127.0.0.1`` +* Port: ``3306`` +* Username: ``root`` +* Password: your MySQL password +* Database Name: ``my_craft`` +* Prefix: leave empty + +.. important:: When chosing the Database server, use ``127.0.0.1`` as the hostname. + + +8. Open your browser +-------------------- + +All set now, you can visit http://my-craft.loc or https://my-craft.loc in your browser. + +.. seealso:: :ref:`setup_valid_https` diff --git a/docs/getting-started/create-your-first-project.rst b/docs/getting-started/create-your-first-project.rst index 5e447cc1..6020a01e 100644 --- a/docs/getting-started/create-your-first-project.rst +++ b/docs/getting-started/create-your-first-project.rst @@ -196,6 +196,7 @@ their articles: * :ref:`example_setup_cakephp` * :ref:`example_setup_codeigniter` + * :ref:`example_setup_craftcms` * :ref:`example_setup_drupal` * :ref:`example_setup_joomla` * :ref:`example_setup_laravel` diff --git a/docs/img/logo_fw/craftcms.png b/docs/img/logo_fw/craftcms.png new file mode 100644 index 00000000..fd289fc8 Binary files /dev/null and b/docs/img/logo_fw/craftcms.png differ diff --git a/docs/index.rst b/docs/index.rst index c60b5033..55319b87 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -139,6 +139,7 @@ host is ready to be served with your custom domain. examples/setup-cakephp examples/setup-codeigniter + examples/setup-craftcms examples/setup-drupal examples/setup-joomla examples/setup-laravel diff --git a/docs/support/faq.rst b/docs/support/faq.rst index cae39dde..4e81cb17 100644 --- a/docs/support/faq.rst +++ b/docs/support/faq.rst @@ -160,6 +160,12 @@ Does it work with Codeigniter? Yes, see :ref:`example_setup_codeigniter` +Does it work with CraftCMS? +--------------------------- + +Yes, see :ref:`example_setup_craftcms` + + Does it work with Drupal? -------------------------