Skip to content

[TASK] Refactor installation and setup chapters #723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 30, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 51 additions & 31 deletions Documentation/Installation/Index.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
:navigation-title: Installation

.. include:: /Includes.rst.txt
.. _installation_index:

.. index:: installation
=====================================
Prepare / Install local TYPO3 project
=====================================

.. _installation_index:
Setting up your local TYPO3 project requires a few simple steps.
This chapter guides you through preparing your development environment,
installing TYPO3, and getting ready to build your first website.

The rest of the Getting Started guide assumes that TYPO3 was installed locally
using DDEV and Composer as described here.

============
Installation
============
If you prefer a different installation method (for example, manual installation
on a server), see the full
`TYPO3 installation guide <https://docs.typo3.org/permalink/t3coreapi:installation-index>`_.

.. toctree::
:hidden:
:titlesonly:

SystemRequirements/Index
Version
UsingDdev
Install
Setup
Version
Updates/Index
DeployTYPO3
ApplicationContext
Updates/Index
SystemRequirements/Index

.. card-grid::
:columns: 1
Expand All @@ -26,41 +38,39 @@ Installation
:class: pb-4
:card-height: 100

.. card:: :ref:`System requirements <system-requirements>`
.. card:: :ref:`Using DDEV <ddev>`

System requirements for the host operating system, including its web
server and database and how they should be configured prior to
installation.
Learn how to install, update, and manage DDEV for running your TYPO3
projects locally.

.. card:: :ref:`Version <typo3-version>`
.. card:: :ref:`Installing TYPO3 with DDEV <install>`

This chapter helps you choose the best TYPO3 version to start with and
provides resources for getting it.
Follow a quick and simple guide to install TYPO3 locally using DDEV,
Docker, and Composer.

.. card:: :ref:`Installing TYPO3 <install>`
.. card:: :ref:`Setting up TYPO3 after installation <typo3-setup>`

This is a step-by-step guide detailing how to install TYPO3 for local
development using DDEV, Docker and Composer.
Complete the TYPO3 setup by creating an admin user and configuring
initial options.

.. card:: :ref:`TYPO3 Updates <getting-started-typo3-updates>`
.. card:: :ref:`Choosing a TYPO3 version <typo3-version>`

Here we explain the cycle of TYPO3 updates, and show you why and when
a TYPO3 update is useful.
Find out which TYPO3 version to start with and where to get it.

.. card:: :ref:`Deploying TYPO3 <DeployTYPO3>`
.. card:: :ref:`Keeping TYPO3 up to date <getting-started-typo3-updates>`

After you have installed TYPO3 locally, learn how to move your result
to a web server.
Learn about TYPO3 update cycles and how to keep your installation secure
and up to date.

.. card:: :ref:`Application context <application-context>`
.. card:: :ref:`Deploying TYPO3 to a server <DeployTYPO3>`

Use the TYPO3 application context to manage settings for
development and production.
Learn how to move your TYPO3 project from your local DDEV environment
to a live web server.

.. _installation_advanced:

Advanced installation topics
============================
=============================

.. card-grid::
:columns: 1
Expand All @@ -69,7 +79,17 @@ Advanced installation topics
:class: pb-4
:card-height: 100

.. card:: :ref:`Tuning TYPO3 <t3coreapi:TuneTYPO3>`
.. card:: :ref:`Application context <application-context>`

Use TYPO3's application context to manage different settings for
development, testing, and production.

.. card:: `System Requirements <https://docs.typo3.org/permalink/t3coreapi:system-requirements>`_

If you install TYPO3 manually or deploy to a production server, check
the full system requirements for PHP, database, and web server.

.. card:: `Tuning TYPO3 <https://docs.typo3.org/permalink/t3coreapi:tunetypo3>`_

This chapter in TYPO3 Explained contains information on how to configure and optimize the
infrastructure running TYPO3.
Learn how to configure, optimize, and fine-tune the infrastructure
running TYPO3 for better performance and scalability.
Loading