Welcome to the TYPO3 installation guide. This guide covers each of the steps required to install TYPO3 using the dependency manager Composer.
Installation And Deployment¶
Composer should only ever be used to install TYPO3 on a local or development environment. By not using Composer in a live environment, the need to install dependencies are completely removed - reducing potential vectors for attack.
Once an installation is ready to go “live”, it should then be moved or “deployed” to the live environment instead.
- Command line (CLI) access with the ability to create directories and symbolic links.
- Access to Composer via the CLI (for local development)
- Access to the web server’s root directory
- Database with appropriate credentials
Execute Composer Create-Project¶
This command pulls down the latest release of TYPO3 and places it in the directory specified ‘YourProjectDirectory’.
After this command has finished running, ‘example-project-directory’ will contain the following structure:
. ├── .gitignore ├── composer.json ├── composer.lock ├── LICENSE ├── public ├── README.md ├── var └── vendor
Create an empty file (without any extension) called
FIRST_INSTALL in the
. ├── .gitignore ├── composer.json ├── composer.lock ├── LICENSE ├── public ├── FIRST_INSTALL ├── README.md ├── var └── vendor
Access TYPO3 via a web browser¶
TYPO3 can now be accessed via a web browser. When accessing a new site for the first time, TYPO3 automatically
redirect all requests to
/typo3/install.php to complete the installation process.
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
trustedHostsPattern error on initial access, accessing TYPO3 without HTTPS (
http://) is also an option.
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.
- 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 aren’t 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 ‘https://example-project-site.local/typo3/install.php’.
Select A Database¶
Select a database connection driver and enter the credentials for the database.
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 database then the PHP extension ‘pdo_mysql’ is required. Once it’s installed, ‘MySQL Database’ will be an available option.(Review)
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 also be given.
TYPO3 offers two options for initialisation: 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.