[BUGFIX] Handle settings for report / check in linkvalidator
[Packages/TYPO3.CMS.git] / INSTALL.md
index 8d72ef7..b74157d 100644 (file)
@@ -13,7 +13,7 @@ This document describes:
 Client browser support
 ----------------------
 
-The TYPO3 backend is accessed through a web browser. TYPO3 CMS 8
+The TYPO3 backend is accessed through a web browser. TYPO3 v8
 supports the following web browsers:
 
 * Internet Explorer 11 and later
@@ -27,7 +27,7 @@ Server system requirements
 --------------------------
 
 TYPO3 requires a web server with a PHP environment and a database. The minimum
-system requirements for running TYPO3 CMS 7 are:
+system requirements for running TYPO3 v8 are:
 
 * Webserver capable of running PHP applications (Apache, Nginx, IIS or other)
 * PHP 7
@@ -41,7 +41,8 @@ therefore only experienced server administrators should create such configuratio
 ### MySQL environment
 
 TYPO3 works with MySQL in the above mentioned versions. It will also work on
-compatible "drop-in" replacements like MariaDB or Percona.
+compatible "drop-in" replacements like MariaDB or Percona. The InnoDB engine
+is required to be enabled.
 
 ### MySQL required privileges
 
@@ -58,8 +59,7 @@ It is recommended to also grant the following privileges:
 ### PHP environment
 
 * memory_limit set to at least 64M
-* max_execution_time set to at least 30s (240s recommended)
-* register_globals disabled
+* max_execution_time set to at least 30 (240 seconds recommended)
 * AllowOverride in the Apache configuration includes "Indexes" and "FileInfo"
   (see FAQ below)
 
@@ -69,13 +69,11 @@ Your PHP needs to support the following extensions. Install will
 check if these are available.
 
 * These are usually part of the standard PHP package on most distributions:
-  * fileinfo
   * filter
   * hash
   * openssl
-  * pcre >= 8.30
+  * pcre >= 8.38
   * session
-  * soap
   * SPL
   * standard
   * xml
@@ -105,7 +103,7 @@ functionality:
 * PHP
   * version 7.0 or later
   * memory_limit set to at least 128M
-  * max_execution_time set to at least 240s
+  * max_execution_time set to at least 240
   * max_input_vars set to at least 1500
 
 * Additional PHP extensions:
@@ -115,6 +113,7 @@ functionality:
   * mbstring
   * FreeType 2 (usually included within the PHP distribution)
   * bcmath or gmp (needed if you'd like to use the openid system extension)
+  * fileinfo (mandatory for proper file type detection)
 
 * PHP access to /dev/urandom or /dev/random on Unix-like platforms for
   increased security. Make sure to add "/dev/random:/dev/urandom" to
@@ -171,6 +170,11 @@ cd ..
   cp typo3_src/_.htaccess .htaccess
 ```
 
+* In case you use IIS, install the URL Rewrite 2.x module and copy the web.config to your Document Root:
+```
+  cp typo3_src/_web.config web.config
+```
+
 You end up with the follow structure of files:
 
 ```
@@ -178,7 +182,8 @@ You end up with the follow structure of files:
   htdocs/typo3_src -> ../typo3_src-8.x.x/
   htdocs/typo3 -> typo3_src/typo3/
   htdocs/index.php -> typo3_src/index.php
-  htdocs/.htaccess
+  htdocs/.htaccess (only on Apache)
+  htdocs/web.config (only on IIS)
 ```
 
 This allows you to upgrade TYPO3 later by simply replacing the symlink
@@ -187,6 +192,8 @@ be found in the Install Tool.
 
 ### Windows specifics
 
+#### Symlinks
+
 On Windows Vista and newer you can create symbolic links using the `mklink` tool:
 ```
   mklink /D C:\<dir>\example.com\typo3_src C:\<dir>\typo3_src-8.x.x
@@ -200,6 +207,24 @@ for files.
 TYPO3 Core upgrades through the Install Tool is not supported under
 Windows.
 
+#### Path length
+
+Up until PHP 7.0 Windows has had problems with lengths of a path.
+The TYPO3 core enforces a maximum path length of 160 characters in itself, leaving
+100 characters for your installation directory. Please note that these 100 characters
+are counted including the drive identifier (C:\ for example).
+
+In case you use composer to install your TYPO3 instance, be aware that composer will
+try to unpack TYPO3 into composer's cache dir first and then move the files to your
+target directory.
+Because composer's cache dir defaults to C:\Users\<user>\AppData\Local\Composer it is
+possible your full path becomes more than the 100 characters you're allowed to use.
+
+You can use the `cache-dir` directive to set a shorter directory specifically for
+your TYPO3 instance.
+
+See: https://getcomposer.org/doc/06-config.md#cache-dir
+
 ### No SSH and symlinks possible (not recommended)
 
 In case you only have FTP or SFTP access to your hosting environment, you
@@ -212,17 +237,17 @@ Please note that this is not a recommended setup!
 * Upload all files and subdirectories directly in your Document Root
   (where files that are served by your webserver are located).
 * In case your provider uses Apache, rename the file `_.htaccess` to `.htaccess`.
+* In case your provider uses IIS, rename the file `_web.config` to `web.config`.
 
 You end up with this files in your Document Root:
 
 ```
- .htaccess
- ChangeLog
- GPL.txt
+ .htaccess (only on Apache)
+ web.config (only on IIS)
+ CONTRIBUTING.md
  index.php
  INSTALL.md
  LICENSE.txt
- NEWS.txt
  README.md
  typo3/
 ```