Skip to content

Commit d48b056

Browse files
linawolflinawolf
authored
[TASK] Update and improve Classic mode installation chapters (#5612)
* [TASK] Update and improve Classic mode installation chapters Releases: main, 13.4 * [TASK] Update and improve Classic mode installation chapters Releases: main, 13.4 * Update Documentation/Administration/Installation/ClassicMode/WgetSymlink.rst * Update Documentation/Administration/Installation/ClassicMode/TarballZip.rst * Update Documentation/Administration/Installation/ClassicMode/WgetSymlink.rst * Update Documentation/Administration/Installation/ClassicMode/WgetSymlink.rst * Update Documentation/Administration/Installation/ClassicMode/Windows.rst * Update TarballZip.rst * [TASK] Update and improve Classic mode installation chapters Releases: main, 13.4
1 parent 77f3d8c commit d48b056

File tree

6 files changed

+433
-112
lines changed

6 files changed

+433
-112
lines changed

‎Documentation/Administration/Installation/ClassicMode/Index.rst

+47-109
Original file line numberDiff line numberDiff line change
@@ -1,140 +1,78 @@
1-
:navigation-title: Classic mode installation
1+
:navigation-title: Classic mode
22

33
.. include:: /Includes.rst.txt
44
.. index:: Classic mode installation
55

66
.. _classic-installation:
77
.. _legacyinstallation:
88

9-
=================================================
10-
Classic TYPO3 installation (No Composer required)
11-
=================================================
9+
======================================================
10+
Classic mode TYPO3 installation (No Composer required)
11+
======================================================
1212

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

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

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

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

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

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

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

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

41-
Installing on a Linux/Unix server
42-
=================================
39+
Prerequisites:
4340

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

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

50-
wget --content-disposition https://get.typo3.org/13
49+
.. card-grid::
50+
:columns: 1
51+
:columns-md: 1
52+
:gap: 4
53+
:class: pb-4
5154

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

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

5761

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

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

63-
tar xzf typo3_src-13.4.y.tar.gz
64-
65-
Note that the `x` in the extracted folder will be replaced with the latest
66-
minor number and the `y` by the bugfix number of TYPO3.
67-
68-
69-
#. Create the following symlinks in the document root:
70-
71-
72-
.. code-block:: bash
73-
:caption: /var/www/site/$
74-
75-
cd public
76-
ln -s ../typo3_src-13.4.y typo3_src
77-
ln -s typo3_src/index.php index.php
78-
ln -s typo3_src/typo3 typo3
79-
80-
.. important::
81-
Make sure to upload the whole TYPO3 source directory including the
82-
:path:`vendor` directory, otherwise you will miss important dependencies.
83-
84-
#. This will then create the following structure:
85-
86-
.. directory-tree::
87-
88-
* :path:`typo3_src-13.4.y/`
89-
* :path:`public/`
90-
91-
* :path:`typo3_src -> ../typo3_src-13.4.y/`
92-
* :path:`typo3 -> typo3_src/typo3/`
93-
* :file:`index.php -> typo3_src/index.php`
94-
95-
.. _legacyinstallation-windows:
96-
97-
Installing on a Windows server
98-
==============================
99-
100-
#. Download TYPO3's source package from `https://get.typo3.org/
101-
<https://get.typo3.org/>`_ and extract the :file:`.zip` file on the web server.
102-
103-
Ensure that the package is one level above the web server's document root.
104-
105-
#. Use the shell to create the following symlinks in the document root:
106-
107-
.. code-block:: bash
108-
:caption: /var/www/site/$
109-
110-
cd public
111-
mklink /d typo3_src ..\typo3_src-13.4.y
112-
mklink /d typo3 typo3_src\typo3
113-
mklink index.php typo3_src\index.php
114-
115-
#. This will then create the following structure:
116-
117-
.. directory-tree::
118-
119-
* :path:`typo3_src-13.4.y/`
120-
* :path:`public/`
121-
122-
* :path:`typo3_src -> ../typo3_src-13.4.y/`
123-
* :path:`typo3 -> typo3_src/typo3/`
124-
* :file:`index.php -> typo3_src/index.php`
125-
126-
.. _legacyinstallation-completion:
127-
128-
Completing the installation
129-
===========================
130-
131-
After the source package has been extracted and the symlinks created, continue from the
132-
:ref:`Access TYPO3 via a web browser <install-access-typo3-via-a-web-browser>`
133-
section of the :ref:`instructions for installing TYPO3 using Composer <install>` to
134-
complete the installation.
67+
You can use the `Release integrity <https://docs.typo3.org/permalink/t3coreapi:release-integrity>`_
68+
to test if the package you just downloaded is signed correctly.
13569

13670
.. toctree::
13771
:hidden:
13872
:titlesonly:
13973

74+
TarballZip
75+
WgetSymlink
76+
Windows
77+
InstallationWizard
14078
ReleaseIntegrity

‎Documentation/Administration/Installation/ClassicMode/InstallationWizard.rst

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
:navigation-title: Installation wizard
2+
3+
.. include:: /Includes.rst.txt
4+
.. _classic-installation-wizard:
5+
6+
=========================================================
7+
Run the installation wizard and complete the installation
8+
=========================================================
9+
10+
.. contents::
11+
12+
.. _classic-install-wizard:
13+
14+
Run the installation wizard
15+
===========================
16+
17+
- Open your web browser and navigate to your TYPO3 site (for example
18+
`https://example.org/`)
19+
- The installation wizard will appear
20+
- Follow the steps:
21+
22+
- Enter the database details you created
23+
- Create an administrator account
24+
- Set the site name
25+
26+
See also the :ref:`web-based installation instructions <install-access-typo3-via-a-web-browser>`.
27+
28+
.. _classic-install-complete:
29+
30+
Complete the setup
31+
------------------
32+
33+
- After completing the installation wizard, log in to the TYPO3 backend at
34+
`/typo3` (for example `https://example.org/typo3`)
35+
- Use the administrator credentials you just created
36+
37+
.. _classic-install-next-steps:
38+
39+
Next steps
40+
==========
41+
42+
- `Create a site package <https://docs.typo3.org/permalink/t3start:creating-a-site-package>`_ for theming
43+
- Add pages and content - see `TYPO3 Editors Guide <https://docs.typo3.org/permalink/t3editors:start>`_
44+
- Create personalized accounts for each backend user - see `Backend user
45+
management <https://docs.typo3.org/permalink/t3coreapi:user-management>`_
46+
- Review system requirements and security settings - see `security guidelines
47+
for system administrators <https://docs.typo3.org/permalink/t3coreapi:security-administrators>`_
48+
- `Install additional extensions <https://docs.typo3.org/permalink/t3coreapi:extensions-legacy-management>`_
49+
for additional functionality.

‎Documentation/Administration/Installation/ClassicMode/ReleaseIntegrity.rst

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: Release integrity
22

3+
.. include:: /Includes.rst.txt
34
.. _release_integrity:
45

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

15+
.. _release_integrity-contents:
16+
1417
Release contents
1518
================
1619

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

35+
.. _release_integrity-hashes:
36+
3237
Checking file hashes
3338
====================
3439

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

98+
.. _release_integrity-signatures:
9399

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

185+
.. _release_integrity-signature-tag:
179186

180187
Checking tag signature
181188
======================
@@ -223,9 +230,10 @@ The :bash:`git show` command on the name of the tag reveals more details.
223230
-----END PGP SIGNATURE-----
224231
225232
233+
.. _release_integrity-signatures-public-key:
226234

227-
Public keys
228-
===========
235+
Public keys for release integrity checks
236+
========================================
229237

230238
.. note::
231239
Starting in June 2017, TYPO3 releases have been cryptographically signed by the

0 commit comments

Comments
 (0)