Skip to content

[TASK] Update and improve Classic mode installation chapters #5612

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 9 commits into from
May 15, 2025
156 changes: 47 additions & 109 deletions Documentation/Administration/Installation/ClassicMode/Index.rst
Original file line number Diff line number Diff line change
@@ -1,140 +1,78 @@
:navigation-title: Classic mode installation
:navigation-title: Classic mode

.. include:: /Includes.rst.txt
.. index:: Classic mode installation

.. _classic-installation:
.. _legacyinstallation:

=================================================
Classic TYPO3 installation (No Composer required)
=================================================
======================================================
Classic mode TYPO3 installation (No Composer required)
======================================================

On any webserver that full fills the `System Requirements <https://docs.typo3.org/permalink/t3coreapi:system-requirements>`_,
including a suitable PHP version and Database it is possible to install TYPO3
by downloading and unpacking a `.tar` or `.zip` file. You can download
this file from https://get.typo3.org/ or - if available - via wget or curl.
There are two installation methods for a Classic mode TYPO3 installation.
If you have shell (SSH) access we recommend using `wget and
symlinks <https://docs.typo3.org/permalink/t3coreapi:classic-symlink-installation>`_.

.. todo: Document recommended Server tools like ssh, cronjob, etc and link to
that chapter
If you only have access via FTP or the file manager of your hosting provider, use
a `.zip or .tar.gz archive <https://docs.typo3.org/permalink/t3coreapi:manual-archive-installation>`_.

To ensure future updates can be achieved smoothly and without noticeable downtime
it is highly recommended to use symlinks.
Choose one of the two methods:

.. tip::
It is recommended to use the dependency manager `Composer <https://getcomposer.org/>`_
if possible: See :ref:`Composer-based installation instructions <install>`.
.. card-grid::
:columns: 1
:columns-md: 2
:gap: 4
:class: pb-4
:card-height: 100

.. warning::
Do not change any files belonging to the TYPO3 Core source as it makes updating
hard or impossible.
.. card:: `.zip or .tar.gz archive <https://docs.typo3.org/permalink/t3coreapi:manual-archive-installation>`_

You can use `Events and hooks <https://docs.typo3.org/permalink/t3coreapi:hooks>`_
or third party extensions.
Prerequisites:

If you absolutely have to change files in the Core source, keep a
`.diff <https://en.wikipedia.org/wiki/Diff>`_ file so you can reapply the
changes to the next TYPO3 version on update.
- A web server with PHP and database support
- FTP access or web-based file manager (such as cPanel)
- A web browser to run the installation wizard

.. _legacyinstallation-linux:
.. card:: `wget and symlinks <https://docs.typo3.org/permalink/t3coreapi:classic-symlink-installation>`_

Installing on a Linux/Unix server
=================================
Prerequisites:

#. Download TYPO3's source package from `https://get.typo3.org/
<https://get.typo3.org/>`_:
- Shell (SSH) access to the server
- Basic server tools such as `wget` or `curl`, `tar`, and `ln` or `mklink`
- A web server with PHP and database support
- A web browser to run the installation wizard

.. code-block:: bash
:caption: /var/www/site/$
The next steps are needed no matter what installation method you chose in the
step before:

wget --content-disposition https://get.typo3.org/13
.. card-grid::
:columns: 1
:columns-md: 1
:gap: 4
:class: pb-4

Ensure that the package is one level above the web server's document root.
.. card:: `Run the installation wizard <https://docs.typo3.org/permalink/t3coreapi:classic-installation-wizard>`_

.. note::
Make sure to check the :ref:`release_integrity` of the downloaded files.
A web-based wizard guides you through the next steps, such as connecting
your installation to the database, creating an administrator user, and
setting up the file system.


#. Unpack the :file:`typo3_src-13.4.y.tar.gz`:
.. card:: `Choose or create a site package (theme) <https://docs.typo3.org/permalink/t3start:creating-a-site-package>`_

.. code-block:: bash
:caption: /var/www/site/$
TYPO3 does not come with a default theme. In order to display any content
on your website, you need to install or create a site package.

tar xzf typo3_src-13.4.y.tar.gz

Note that the `x` in the extracted folder will be replaced with the latest
minor number and the `y` by the bugfix number of TYPO3.


#. Create the following symlinks in the document root:


.. code-block:: bash
:caption: /var/www/site/$

cd public
ln -s ../typo3_src-13.4.y typo3_src
ln -s typo3_src/index.php index.php
ln -s typo3_src/typo3 typo3

.. important::
Make sure to upload the whole TYPO3 source directory including the
:path:`vendor` directory, otherwise you will miss important dependencies.

#. This will then create the following structure:

.. directory-tree::

* :path:`typo3_src-13.4.y/`
* :path:`public/`

* :path:`typo3_src -> ../typo3_src-13.4.y/`
* :path:`typo3 -> typo3_src/typo3/`
* :file:`index.php -> typo3_src/index.php`

.. _legacyinstallation-windows:

Installing on a Windows server
==============================

#. Download TYPO3's source package from `https://get.typo3.org/
<https://get.typo3.org/>`_ and extract the :file:`.zip` file on the web server.

Ensure that the package is one level above the web server's document root.

#. Use the shell to create the following symlinks in the document root:

.. code-block:: bash
:caption: /var/www/site/$

cd public
mklink /d typo3_src ..\typo3_src-13.4.y
mklink /d typo3 typo3_src\typo3
mklink index.php typo3_src\index.php

#. This will then create the following structure:

.. directory-tree::

* :path:`typo3_src-13.4.y/`
* :path:`public/`

* :path:`typo3_src -> ../typo3_src-13.4.y/`
* :path:`typo3 -> typo3_src/typo3/`
* :file:`index.php -> typo3_src/index.php`

.. _legacyinstallation-completion:

Completing the installation
===========================

After the source package has been extracted and the symlinks created, continue from the
:ref:`Access TYPO3 via a web browser <install-access-typo3-via-a-web-browser>`
section of the :ref:`instructions for installing TYPO3 using Composer <install>` to
complete the installation.
You can use the `Release integrity <https://docs.typo3.org/permalink/t3coreapi:release-integrity>`_
to test if the package you just downloaded is signed correctly.

.. toctree::
:hidden:
:titlesonly:

TarballZip
WgetSymlink
Windows
InstallationWizard
ReleaseIntegrity
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
:navigation-title: Installation wizard

.. include:: /Includes.rst.txt
.. _classic-installation-wizard:

=========================================================
Run the installation wizard and complete the installation
=========================================================

.. contents::

.. _classic-install-wizard:

Run the installation wizard
===========================

- Open your web browser and navigate to your TYPO3 site (for example
`https://example.org/`)
- The installation wizard will appear
- Follow the steps:

- Enter the database details you created
- Create an administrator account
- Set the site name

See also the :ref:`web-based installation instructions <install-access-typo3-via-a-web-browser>`.

.. _classic-install-complete:

Complete the setup
------------------

- After completing the installation wizard, log in to the TYPO3 backend at
`/typo3` (for example `https://example.org/typo3`)
- Use the administrator credentials you just created

.. _classic-install-next-steps:

Next steps
==========

- `Create a site package <https://docs.typo3.org/permalink/t3start:creating-a-site-package>`_ for theming
- Add pages and content - see `TYPO3 Editors Guide <https://docs.typo3.org/permalink/t3editors:start>`_
- Create personalized accounts for each backend user - see `Backend user
management <https://docs.typo3.org/permalink/t3coreapi:user-management>`_
- Review system requirements and security settings - see `security guidelines
for system administrators <https://docs.typo3.org/permalink/t3coreapi:security-administrators>`_
- `Install additional extensions <https://docs.typo3.org/permalink/t3coreapi:extensions-legacy-management>`_
for additional functionality.
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. include:: /Includes.rst.txt
:navigation-title: Release integrity

.. include:: /Includes.rst.txt
.. _release_integrity:

=======================
Expand All @@ -11,6 +12,8 @@ Git tags are signed using :abbr:`PGP (Pretty Good Privacy)` signatures during
the automated release process. SHA2-256, SHA1 and MD5 hashes are also generated
for these files.

.. _release_integrity-contents:

Release contents
================

Expand All @@ -29,6 +32,8 @@ Every release of TYPO3 is made available with the following files:
* :file:`*.sig` files contain the corresponding signatures for each release
package file

.. _release_integrity-hashes:

Checking file hashes
====================

Expand Down Expand Up @@ -90,6 +95,7 @@ These hashes must match the hashes published on get.typo3.org to ensure package
.. _MD5: https://en.wikipedia.org/wiki/MD5
.. _SHA2-256: https://en.wikipedia.org/wiki/SHA-2

.. _release_integrity-signatures:

Checking file signatures
========================
Expand Down Expand Up @@ -176,6 +182,7 @@ of currently used keys or access the https://get.typo3.org/KEYS file directly).
.. _OpenPGP: http://www.openpgp.org/
.. _pgpkeys.mit.edu: https://pgpkeys.mit.edu/

.. _release_integrity-signature-tag:

Checking tag signature
======================
Expand Down Expand Up @@ -223,9 +230,10 @@ The :bash:`git show` command on the name of the tag reveals more details.
-----END PGP SIGNATURE-----


.. _release_integrity-signatures-public-key:

Public keys
===========
Public keys for release integrity checks
========================================

.. note::
Starting in June 2017, TYPO3 releases have been cryptographically signed by the
Expand Down
Loading