diff --git a/Documentation/Administration/Installation/ClassicMode/Index.rst b/Documentation/Administration/Installation/ClassicMode/Index.rst index 30a21fdd5..672aefbb5 100644 --- a/Documentation/Administration/Installation/ClassicMode/Index.rst +++ b/Documentation/Administration/Installation/ClassicMode/Index.rst @@ -1,4 +1,4 @@ -:navigation-title: Classic mode installation +:navigation-title: Classic mode .. include:: /Includes.rst.txt .. index:: Classic mode installation @@ -6,135 +6,73 @@ .. _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 `_, -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 `_. -.. 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 `_. -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 `_ - if possible: See :ref:`Composer-based installation instructions `. +.. 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 `_ - You can use `Events and hooks `_ - or third party extensions. + Prerequisites: - If you absolutely have to change files in the Core source, keep a - `.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 `_ -Installing on a Linux/Unix server -================================= + Prerequisites: -#. Download TYPO3's source package from `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 `_ - .. 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) `_ - .. 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/ - `_ 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 ` -section of the :ref:`instructions for installing TYPO3 using Composer ` to -complete the installation. +You can use the `Release integrity `_ +to test if the package you just downloaded is signed correctly. .. toctree:: :hidden: :titlesonly: + TarballZip + WgetSymlink + Windows + InstallationWizard ReleaseIntegrity diff --git a/Documentation/Administration/Installation/ClassicMode/InstallationWizard.rst b/Documentation/Administration/Installation/ClassicMode/InstallationWizard.rst new file mode 100644 index 000000000..cb30a7256 --- /dev/null +++ b/Documentation/Administration/Installation/ClassicMode/InstallationWizard.rst @@ -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 `. + +.. _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 `_ for theming +- Add pages and content - see `TYPO3 Editors Guide `_ +- Create personalized accounts for each backend user - see `Backend user + management `_ +- Review system requirements and security settings - see `security guidelines + for system administrators `_ +- `Install additional extensions `_ + for additional functionality. diff --git a/Documentation/Administration/Installation/ClassicMode/ReleaseIntegrity.rst b/Documentation/Administration/Installation/ClassicMode/ReleaseIntegrity.rst index a465f08a9..342265684 100644 --- a/Documentation/Administration/Installation/ClassicMode/ReleaseIntegrity.rst +++ b/Documentation/Administration/Installation/ClassicMode/ReleaseIntegrity.rst @@ -1,5 +1,6 @@ -.. include:: /Includes.rst.txt +:navigation-title: Release integrity +.. include:: /Includes.rst.txt .. _release_integrity: ======================= @@ -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 ================ @@ -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 ==================== @@ -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 ======================== @@ -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 ====================== @@ -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 diff --git a/Documentation/Administration/Installation/ClassicMode/TarballZip.rst b/Documentation/Administration/Installation/ClassicMode/TarballZip.rst new file mode 100644 index 000000000..b720dbc1a --- /dev/null +++ b/Documentation/Administration/Installation/ClassicMode/TarballZip.rst @@ -0,0 +1,111 @@ +:navigation-title: ZIP/Tarball + +.. include:: /Includes.rst.txt +.. _manual-archive-installation: + +======================================================== +Classic TYPO3 installation using .zip or .tar.gz archive +======================================================== + +This guide explains how to install TYPO3 manually using FTP or a web hosting +control panel such as cPanel, without requiring command-line access. + +Prerequisites: + +- A web server such as **Apache** or **nginx** +- A PHP version and required extensions supported by the TYPO3 version you + plan to install. See `System requirements + `_. +- A database such as MySQL or MariaDB +- FTP access or web-based file manager (such as cPanel) +- A web browser to run the installation wizard + +.. _manual-archive-download: + +Download the TYPO3 package +========================== + +- Go to https://get.typo3.org +- Select the TYPO3 version you want to install +- Download the `.zip` package to your computer (this is recommended for + most users) +- Alternatively, download the `.tar.gz` package if your hosting environment + supports extracting `.tar.gz` archives + +.. _manual-archive-upload-extract: + +Upload and extract the package +============================== + +- Open your FTP program or web-based file manager +- Create a folder on your webspace where you want to install TYPO3, for + example :path:`/public_html/typo3site` +- Upload the TYPO3 `.zip` file (for example :file:`typo3_src-13.4.y.zip`) directly + to this folder and extract it using the tools provided by your servers file manager. + + If your server does not offer an option to extract files, + see :ref:`manual-archive-alternative-upload` +- After extraction, you have a folder named something like + :path:`typo3_src-13.4.11`. Move all files and folder contained from this + folder into **the folder where your domain or + subdomain’s document root points to**. + + This may be the root of your webspace (for example :path:`/public_html/`) or a + subfolder (for example :path:`/public_html/typo3site/`), depending on how your + domain or subdomain is configured. + +.. _manual-archive-upload-extract-symlinks: + +Best practice: use symlinks to TYPO3 source (optional) +------------------------------------------------------ + +On systems where you have shell access, the recommended method is to keep +TYPO3 source packages in a dedicated folder, such as +`/typo3_sources/typo3_src-13.4.y/`, and create symbolic links from your project +folder (webroot) to the required parts of the TYPO3 source. + +This keeps your project clean and simplifies future upgrades. + +For detailed instructions, refer to +`Classic TYPO3 installation (no Composer required) +`_. + +If shell access is not available, uploading and extracting the TYPO3 package +directly into the folder where your domain points to is the most practical +option. + +.. _manual-archive-alternative-upload: + +Alternative: upload extracted files +----------------------------------- + +If your control panel does not provide an option to extract `.zip` or `.tar` +files: + +- Extract the archive on your local computer +- Upload all extracted files and folders to your installation folder using + your FTP program +- Ensure you upload the contents only, not the containing folder itself + +.. _manual-archive-database: + +Create a database +================= + +- Log in to your hosting control panel (such as cPanel) +- Create a new database (MySQL or MariaDB) and a user, and assign the user to + the database with full privileges +- Make a note of the database name, username, and password for later use + +.. _manual-archive-completion: + +Run the installation wizard and complete the installation +========================================================= + +In the next steps you will use the installation wizard to connect the database, +create additional required folders, create an administrator and chose or create +a site package / theme: + +.. seealso:: + + :ref:`classic-installation-wizard` diff --git a/Documentation/Administration/Installation/ClassicMode/WgetSymlink.rst b/Documentation/Administration/Installation/ClassicMode/WgetSymlink.rst new file mode 100644 index 000000000..d96b1564d --- /dev/null +++ b/Documentation/Administration/Installation/ClassicMode/WgetSymlink.rst @@ -0,0 +1,125 @@ +:navigation-title: Wget and Symlinks + +.. include:: /Includes.rst.txt +.. index:: Classic mode installation; Wget and symlinks + +.. _classic-symlink-installation: + +=================================================================== +Classic TYPO3 installation on linux using symlinks and shell access +=================================================================== + +.. note:: + These instructions describe how to install TYPO3 in classic mode. + This approach makes updates, deployment, and maintenance more difficult + compared to using Composer. + + If possible, use the dependency manager `Composer `_. + See :ref:`Composer-based installation instructions `. + +This guide explains how to install TYPO3 manually on a Linux/Unix or Windows +server using a `.tar.gz` or `.zip` archive. Shell access is required to +create symbolic links, which makes future upgrades easier. + +Prerequisites: + +- Shell (SSH) access to the server. + If you do not have shell access, see + `Manual TYPO3 installation using .zip or .tar.gz archive + `_. +- Basic server tools such as `wget` or `curl`, `tar`, and `ln` or `mklink` +- A web server such as **Apache** or **nginx** +- A PHP version and required PHP extensions supported by the TYPO3 version you + plan to install. See `System requirements + `_. +- A database such as MySQL or MariaDB +- A web browser to run the installation wizard + +You can install TYPO3 on any server that meets the `system requirements +`_, +including a suitable PHP version and database. + +You can download TYPO3 either via a web browser from https://get.typo3.org/ +or directly on the server using `wget` or `curl`. + +.. todo:: + Document recommended server tools like SSH, cron jobs, etc., and link to + that chapter when available. + +To ensure that future upgrades can be performed smoothly and with minimal +downtime, it is highly recommended to use symbolic links. + +.. contents:: + +.. _classic-symlink-installation-linux: +.. _legacyinstallation-linux: + +Installing TYPO3 on a Linux or Unix server +========================================== + +.. _classic-symlink-installation-linux-download: + +Download the TYPO3 source package using wget +-------------------------------------------- + +Download the TYPO3 source package from `https://get.typo3.org/ +`_: + +.. code-block:: bash + :caption: /var/www/site/$ + + wget --content-disposition https://get.typo3.org/13 + +Ensure that the package is placed one level above the web server's document root. + +.. note:: + Make sure to check the :ref:`release_integrity` of the downloaded files. + +.. _classic-symlink-installation-linux-untar: + +Unpack the TYPO3 package using tar +---------------------------------- + +Unpack the :file:`typo3_src-13.4.y.tar.gz`: + +.. code-block:: bash + :caption: /var/www/site/$ + + tar xzf typo3_src-13.4.y.tar.gz + +The `y` placeholders in the folder name will be replaced with the +latest patch version number of TYPO3. + +.. _classic-symlink-installation-linux-ln: + +Create the required symlinks using ln +------------------------------------- + +Create the following symlinks in your document root: + +.. code-block:: bash + :caption: /var/www/site/$ + + 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 entire TYPO3 source directory, including the + :path:`vendor` directory. Missing this directory will result in missing + dependencies. + +.. _classic-symlink-installation-linux-directory: + +Expected directory structure +---------------------------- + +After creating the symlinks, your directory structure should look like this: + +.. 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` diff --git a/Documentation/Administration/Installation/ClassicMode/Windows.rst b/Documentation/Administration/Installation/ClassicMode/Windows.rst new file mode 100644 index 000000000..6cc955218 --- /dev/null +++ b/Documentation/Administration/Installation/ClassicMode/Windows.rst @@ -0,0 +1,90 @@ +:navigation-title: Windows servers + +.. include:: /Includes.rst.txt +.. index:: Classic mode installation; Wget and symlinks; Windows + +.. _classic-symlink-installation-windows: + +========================================================== +Classic TYPO3 installation using symlinks on a Windows server +========================================================== + +While it is possible to run TYPO3 on Windows, you might encounter Windows- +specific limitations or issues. + +If you have the choice, we recommend using a **LAMP** stack (Linux, Apache, +MySQL or MariaDB, and PHP). You can then install TYPO3 using +`Composer `_ +(recommended) or in +`classic mode `_. + +For local development on Windows PCs, we recommend using **WSL2** or running +Linux-based environments using **Docker**. + +.. contents:: + :local: + :depth: 1 + +.. _classic-symlink-installation-windows-zip: + +Download and extract the TYPO3 package using zip +================================================ + +Download the TYPO3 source package from `https://get.typo3.org/ +`_ and extract the :file:`.zip` file on your server. + +Ensure that the package is placed **one level above the web server's document +root**. + +.. _classic-symlink-installation-windows-symlinks: + +Create the required symlinks using mklink +========================================= + +Use the Windows command shell (cmd.exe) with administrator rights to create the +following symlinks in your document root: + +.. code-block:: bash + :caption: C:\path\to\your\site\ + + mklink /d typo3_src ..\typo3_src-13.4.y + mklink /d typo3 typo3_src\typo3 + mklink index.php typo3_src\index.php + +.. note:: + On Windows, **mklink** requires administrator rights. + +.. important:: + Make sure to include the entire TYPO3 source directory, including the + :path:`vendor` directory. Missing this directory will result in missing + dependencies. + +Expected directory structure on Windows +======================================= + +After creating the symlinks, your directory structure should look like this: + +.. 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` + +.. _classic-symlink-installation-completion: +.. _legacyinstallation-completion: + +Run the installation wizard and complete the installation +========================================================= + +In the next steps, you will use the installation wizard to: + +- Connect TYPO3 to your database +- Create required folders +- Create an administrator user +- Choose or create a site package (theme) + +.. seealso:: + + :ref:`classic-installation-wizard`