Skip to content

Commit

Permalink
docs: Minor updates to DDEV tutorial (#382)
Browse files Browse the repository at this point in the history
  • Loading branch information
rfay authored May 22, 2024
1 parent f0d2f7c commit 77d12ac
Showing 1 changed file with 17 additions and 20 deletions.
37 changes: 17 additions & 20 deletions Documentation/Installation/TutorialDdev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ project-type
Should always be "typo3"

docroot
Is the folder in which all files that have to be reached by
the browser. This folder is commonly called :file:`public`.
Is the folder containing files that have to be reached by
the webserver. It contains the vital entry point :file:`index.php`. The folder is commonly called :file:`public`.

Alternatively you can skip the prompt by supplying all of the required parameters in a single command:

Expand All @@ -75,7 +75,7 @@ Start the project
ddev start
The webserver is now running but TYPO3 is not installed.
The webserver is now running but TYPO3 is not yet installed.

Install TYPO3
-------------
Expand All @@ -84,9 +84,6 @@ Install TYPO3
ddev composer create "typo3/cms-base-distribution:^13"
As we just created the project and have no, answer yes
when prompted if it is ok to overwrite files in this directory.

You now have a **Composer-based TYPO3 installation**.

Run the Installation Setup Tool
Expand All @@ -103,7 +100,7 @@ Interactive / guided setup (questions/answers):

.. code-block:: bash
ddev exec ./vendor/bin/typo3 setup
ddev typo3 setup
Setup TYPO3 with the 1,2,3 Install Tool in the browser
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -118,36 +115,31 @@ Open the installer

.. code-block:: bash
ddev launch typo3/install.php
ddev launch /typo3/install.php
Go to the TYPO3 backend:

.. code-block:: bash
ddev launch typo3
ddev launch /typo3
And login with the credentials you just provided.


Managing the Database
---------------------

Upon calling :bash:`ddev config` DDEV automatically created a database for
you. DDEV also created a file called :file:`config/system/additional.php`
in which it stored the database credentials for you.

During the installation setup process TYPO3 created all the tables it needed.
If you want to have a look at the database, you can run the following command:

.. code-block:: bash
:bash:`ddev start` automatically created a database for
you. DDEV also created the file :file:`config/system/additional.php`
in which it configured the database credentials for you.

ddev launch -p
Many database browsers, including phpMyAdmin, are available to let you browse the database, see `Database GUIs <https://ddev.readthedocs.io/en/stable/users/usage/database-management/#database-guis/>__`

Sending E-Mail
--------------

DDEV creates :file:`config/system/additional.php`
to fake sending mails. You can see what mails have been sent here:
DDEV creates configuration in :file:`config/system/additional.php`
to capture sent mails. You can see what mails have been sent here:

.. code-block:: bash
Expand Down Expand Up @@ -177,3 +169,8 @@ calling the following command in your new projects root folder:
This will remove all containers from the project and delete the database.

Afterwards you can safely delete the project's root folder.

DDEV Documentation
------------------

You will want to visit `DDEV's documentation <https://ddev.readthedocs.io/>__`, which also has a `TYPO3 Quick Start <https://ddev.readthedocs.io/en/stable/users/quickstart/#typo3/>__` which parallels this one.

0 comments on commit 77d12ac

Please sign in to comment.