..  include:: /Includes.rst.txt

..  index:: installation, deployment, requirements

..  _install:

================
Installing TYPO3
================

This chapter covers each of the steps required to install TYPO3 using Composer.

For more information on how to deploy TYPO3 to a live environment, visit the
:ref:`deploying TYPO3 <DeployTYPO3>` chapter.

.. contents::
   :local:


Pre-installation checklist
==========================

*   Command line (CLI) access with the ability to create directories and
    symbolic links.
*   Access to `Composer <https://getcomposer.org>`__ via the CLI (for local
    development)
*   Access to the web server's root directory
*   Database with appropriate credentials


Create the project with Composer
================================

The following command will install TYPO3 v12. If you want to install another
version of TYPO3 find documentation by using the version selector on the left side of this page.

At the root level of your web server, execute the following command:

..  tabs::

    ..  group-tab:: bash

        ..  code-block:: bash

            composer create-project typo3/cms-base-distribution example-project-directory "^12"

    ..  group-tab:: powershell

        ..  code-block:: powershell

            composer create-project "typo3/cms-base-distribution:^12" example-project-directory

    ..  group-tab:: ddev

        ..  code-block:: bash

            # Create a directory for your project
            mkdir example-project-directory

            # Go into that directory
            cd example-project-directory

            # Tell DDEV to create a new project of type "typo3"
            # 'docroot' MUST be set to 'public'
            # At least PHP 8.1 is required by TYPO3 v12. Adapt the PHP version to your needs.
            ddev config --project-type=typo3 --docroot=public --php-version 8.1

            # Start the server
            ddev start

            # Fetch a basic TYPO3 installation and its dependencies
            ddev composer create "typo3/cms-base-distribution:^12"


This command pulls down the latest release of the given TYPO3 version and places
it in the :file:`example-project-directory/`.

After this command has finished running, the :file:`example-project-directory/`
folder contains the following structure:

..  code-block:: text

    .
    ├── .gitignore
    ├── composer.json
    ├── composer.lock
    ├── LICENSE
    ├── public
    ├── README.md
    ├── var
    └── vendor


Run the setup process
=====================

Setup TYPO3 in the console
--------------------------

..  versionadded:: 12.1
    A :ref:`CLI command <t3coreapi:symfony-console-commands>` `setup` has
    been introduced as an alternative to the existing
    :abbr:`GUI (Graphical User Interface)`-based web installer.

Interactive / guided setup (questions/answers):

..  tabs::

    ..  group-tab:: bash

        ..  code-block:: bash

            # Use console command to run the install process
            # or use the Install Tool GUI (See below)
            ./vendor/bin/typo3 setup

    ..  group-tab:: powershell

        ..  code-block:: powershell

            # Use console command to run the install process
            # or use the Install Tool GUI (See below)
            ./vendor/bin/typo3 setup

    ..  group-tab:: ddev

        ..  code-block:: bash

            # Use console command to run the install process
            # or use the Install Tool GUI (See below)
            ddev exec ./vendor/bin/typo3 setup

Or use the GUI installer in the browser
---------------------------------------

Create an empty file called `FIRST_INSTALL` in the `public/` directory:

..  tabs::

    ..  group-tab:: bash

        ..  code-block:: bash

            touch example-project-directory/public/FIRST_INSTALL

    ..  group-tab:: powershell

        ..  code-block:: powershell

            echo $null >> public/FIRST_INSTALL

    ..  group-tab:: ddev

        ..  code-block:: bash

            ddev exec touch public/FIRST_INSTALL

..  code-block:: text

    .
    ├── .gitignore
    ├── composer.json
    ├── composer.lock
    ├── LICENSE
    ├── public
        └── FIRST_INSTALL
    ├── README.md
    ├── var
    └── vendor

Access TYPO3 via a web browser
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

After you have configured your web server to point at the `public` directory of
your project, TYPO3 can be accessed via a web browser. When accessing a new site
for the first time, TYPO3 automatically redirects all requests to
:samp:`/typo3/install.php` to complete the installation process.

..  tip::
    When accessing the page via HTTPS, a "Privacy error" or similar warning is
    likely to occur. In a local environment it is safe to ignore this warning by
    forcing the browser to ignore similar exceptions for this domain.

    The warning is due to the fact that self-signed certificates are being used.

    If there is a :ref:`trustedHostsPattern <t3coreapi:typo3ConfVars_sys_trustedHostsPattern>`
    error on initial access, accessing TYPO3 without HTTPS (`http://`) is also
    an option.


Scan environment
~~~~~~~~~~~~~~~~

TYPO3 will now scan the host environment. During the scan TYPO3 will check the
host system for the following:

*   Minimum required version of PHP is installed.
*   Required PHP extensions are loaded.
*   :file:`php.ini` is configured.
*   TYPO3 is able to create and delete files and directories within the
    installation's root directory.

If no issues are detected, the installation process can continue.

In the event that certain criteria are not met, TYPO3 will display a list of
issues it has detected accompanied by a resolution for each issue.

Once changes have been made, TYPO3 can re-scan the host environment by reloading
the page :samp:`https://example-project-site.local/typo3/install.php`.

..  include:: ../Images/AutomaticScreenshots/QuickInstall/Step1SystemEnvironment.rst.txt

Select a database
~~~~~~~~~~~~~~~~~

Select a database connection driver and enter the credentials for the database.

..  include:: ../Images/AutomaticScreenshots/QuickInstall/Step2DatabaseConnection.rst.txt

TYPO3 can either connect to an existing empty database or create a new one.

The list of databases available is dependent on which database drivers are
installed on the host.

For example, if an instance of TYPO3 is intended to be used with a MySQL/MariaDB
database then the PHP extension "pdo_mysql" is required. Once it is installed,
:guilabel:`MySQL Database` will be available as an option.

..  include:: ../Images/AutomaticScreenshots/QuickInstall/Step3ChooseDb.rst.txt

Create administrative user & set site name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

An administrator account needs to be created to gain access to TYPO3's backend.

An email address for this user can also be specified and a name can be given.

..  include:: ../Images/AutomaticScreenshots/QuickInstall/Step4AdminUserSitename.rst.txt

..  note::
    The password must comply with the configured
    :ref:`password policy <t3coreapi:password-policies>`.

Initialize
----------

TYPO3 offers two options for initialization: creating an empty starting page or
it can go directly to the backend administrative interface. Beginners should
select the first option and allow TYPO3 to create an empty starting page.
This will also generate a site configuration file.

..  include:: ../Images/AutomaticScreenshots/QuickInstall/Step5LastStep.rst.txt

Next steps
----------

Now that the installation is complete, TYPO3 can be :ref:`configured <setup>`.

Using DDEV
----------

A step-by-step tutorial is available on how to
:ref:`Install TYPO3 using DDEV <installation-ddev-tutorial>`.
The tutorial also includes a video.