From 1228f5d97a16c24e1c0db19503433ac01aacec7d Mon Sep 17 00:00:00 2001 From: cytopia Date: Tue, 3 Jul 2018 16:27:00 +0200 Subject: [PATCH] Add example to setup Typo3 --- docs/examples/setup-typo3.rst | 141 ++++++++++++++++++ .../create-your-first-project.rst | 1 + docs/index.rst | 1 + docs/support/faq.rst | 6 + 4 files changed, 149 insertions(+) create mode 100644 docs/examples/setup-typo3.rst diff --git a/docs/examples/setup-typo3.rst b/docs/examples/setup-typo3.rst new file mode 100644 index 00000000..6d05466e --- /dev/null +++ b/docs/examples/setup-typo3.rst @@ -0,0 +1,141 @@ +.. _example_setup_typo3: + +*********** +Setup Typo3 +*********** + +This example will use ``composer`` to install Typo3 from within the PHP container. + +.. seealso:: `Official Typo3 Documentation `_ + + +**Table of Contents** + +.. contents:: :local: + + +Overview +======== + +The following configuration will be used: + ++--------------+--------------------------+-------------+------------+-----------------------+ +| Project name | VirtualHost directory | Database | TLD_SUFFIX | Project URL | ++==============+==========================+=============+============+=======================+ +| my-typo | /shared/httpd/my-typo | my_typo | loc | http://my-typo.loc | ++--------------+--------------------------+-------------+------------+-----------------------+ + + +Walk through +============ + +It will be ready in eight simple steps: + +1. Enter the PHP container +2. Create a new VirtualHost directory +3. Install Typo3 via ``composer`` +4. Symlink webroot directory +5. Setup DNS record +6. Create ``FIRST_INSTALL`` file +7. Open your browser +8. Step through guided web installation + + +.. seealso:: :ref:`available_tools` + + +1. Enter the PHP container +-------------------------- + +.. code-block:: bash + + host> ./shell.sh + +.. seealso:: :ref:`work_inside_the_php_container` + + +2. Create new vhost directory +----------------------------- + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd $ mkdir my-typo + + +3. Install Typo3 +---------------- + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd $ cd my-typo + devilbox@php-7.0.20 in /shared/httpd/my-typo $ composer create-project typo3/cms-base-distribution typo3 + + +4. Symlink webroot +------------------ + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd/my-typo $ ln -s typo3/public htdocs + + +5. DNS record +------------- + +If you do not have :ref:`setup_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-typo.loc + +.. seealso:: + + * :ref:`howto_add_project_dns_entry_on_mac` + * :ref:`howto_add_project_dns_entry_on_win` + * :ref:`setup_auto_dns` + + +6. Create ``FIRST_INSTALL`` file +-------------------------------- + +To continue installing via the guided web install, you need to create a file called +``FIRST_INSTALL`` in the document root. + +.. code-block:: bash + + devilbox@php-7.0.20 in /shared/httpd/my-typo $ touch htdocs/FIRST_INSTALL + + +7. Open your browser +-------------------- + +Open your browser at http://my-typo.loc. + + +8. Step through guided web installation +--------------------------------------- + +1. Select database + + * Connection: Manually configured MySWQL TCP/IP connection + * Username: root + * Password + * Host: 127.0.0.1 + * Port: 3306 + +2. Select database + + * Create a new database: ``typo3`` + +3. Create Administrative User / Specify Site Name + + * Username: admin + * Password: choose a secure password + * Site name: My Typo + +4. Installation complete + + * Create empty starting page diff --git a/docs/getting-started/create-your-first-project.rst b/docs/getting-started/create-your-first-project.rst index bc784e24..f60f951c 100644 --- a/docs/getting-started/create-your-first-project.rst +++ b/docs/getting-started/create-your-first-project.rst @@ -200,6 +200,7 @@ their articles: * :ref:`example_setup_phalcon` * :ref:`example_setup_photon_cms` * :ref:`example_setup_symfony` + * :ref:`example_setup_typo3` * :ref:`example_setup_wordpress` * :ref:`example_setup_yii` * :ref:`example_setup_zend` diff --git a/docs/index.rst b/docs/index.rst index b4251215..200d58d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -120,6 +120,7 @@ host is ready to be served with your custom domain. examples/setup-phalcon examples/setup-photon-cms examples/setup-symfony + examples/setup-typo3 examples/setup-wordpress examples/setup-yii examples/setup-zend diff --git a/docs/support/faq.rst b/docs/support/faq.rst index bf689339..6b968bd6 100644 --- a/docs/support/faq.rst +++ b/docs/support/faq.rst @@ -195,6 +195,12 @@ Does it work with Symfony? Yes, see :ref:`example_setup_symfony` +Does it work with Typo3? +------------------------ + +Yes, see :ref:`example_setup_typo3` + + Does it work with Wordpress? ----------------------------