[TASK] CGL FunctionCallArgumentSpacingNoSpaceAfterComma in /t3lib/
[Packages/TYPO3.CMS.git] / INSTALL.txt
index a625c33..72d7edb 100644 (file)
@@ -1,14 +1,19 @@
-                             INSTALL
+*******************************************************************************
+INSTALLING TYPO3
+*******************************************************************************
 
 This document is a part of the TYPO3 project. TYPO3 is an open source web
 content management system released under the GNU GPL. TYPO3 is copyright
-(c) 1999-2009 by Kasper Skaarhoj.
+(c) 1999-2011 by Kasper Skaarhoj.
 
 This document describes the system requirements for TYPO3 and the installation
 routine.
 
+
+===============================================================================
 System requirements
-===================
+===============================================================================
+
 TYPO3 requires a web server with a PHP installation and a database. While TYPO3
 can be configured to run on many web servers with different databases, this
 document assumes that Apache and MySQL will be used. This document does not
@@ -16,50 +21,71 @@ cover using TYPO3 with other databases or web servers.
 
 The following configuration is the minimum required:
 - a web server capable of running PHP
-- PHP 5.2.0 or newer with the following extensions:
- - filter
- - GD2
- - JSON
- - mysql
- - pcre
- - session
- - SPL
- - standard
- - xml
- Some extensions can be optionally compiled into PHP. A list of loaded
- extensions can be checked using the phpinfo() function.
-- memory_limit set to at least to 64M in php.ini
-- MySQL 4.1 or newer
+- PHP 5.3.0 or newer with the following extensions:
+       - fileinfo
+       - filter
+       - GD2
+       - JSON
+       - mysql
+       - openssl
+       - pcre
+       - session
+       - SOAP
+       - SPL
+       - standard
+       - xml
+       - zlib
+       Some extensions can be optionally compiled into PHP. A list of loaded
+       extensions can be checked using the phpinfo() function.
+- memory_limit set to at least 64M in php.ini
+- MySQL 5.0 or newer
 - 200 MB of disk space
-- AllowOverride in the Apache configuration includes "Indexes" (see FAQ below)
+- AllowOverride in the Apache configuration includes "Indexes" and "FileInfo"
+  (see FAQ below)
 
 The following configuration is recommended:
 - Apache 2.x
 - mod_expires and mod_rewrite enabled in the Apache configuration
-- PHP 5.2.0 or newer with the following extensions:
- - cURL
- - filter
- - GD2
- - JSON
- - mbstring
- - mysql
- - pcre
- - session
- - SPL
- - standard
- - xml
- Some extensions can be optionally compiled into PHP. A list of loaded
- extensions can be checked using the phpinfo() function.
+- PHP 5.3.0 or newer with the following extensions:
+       - cURL
+       - filter
+       - GD2
+       - hash
+       - JSON
+       - mbstring
+       - mysql
+       - openssl
+       - pcre
+       - session
+       - SOAP
+       - SPL
+       - standard
+       - xml
+       - zlib
+       Some extensions can be optionally compiled into PHP. A list of loaded
+       extensions can be checked using the phpinfo() function.
+- Safe mode is not supported, thus it must not be activated
+- Magic Quotes is deprecated, thus it should be deactivated
 - memory_limit set to 128M or more in php.ini
 - MySQL 5.1 or newer
-- GraphicsMagick
+- GraphicsMagick or ImageMagick v6 or newer
 - 200 MB or more of disk space
-- AllowOverride in the Apache configuration includes "Indexes" (see FAQ below)
+- AllowOverride in the Apache configuration includes "Indexes" and "FileInfo"
+  (see FAQ below)
 
+TYPO3 uses /dev/urandom or /dev/random on Unix-like platforms for security
+purposes. Access to these files is highly recommended and increases TYPO3
+security. Make sure to add "/dev/random:/dev/urandom" to open_basedir
+settings if you use it. If these paths are unavailable, TYPO3 will attempt to
+simulate random number generation. This is less secure, causes performance
+issues and warnings in the TYPO3 system log.
+
+===============================================================================
 Obtaining TYPO3
-===============
+===============================================================================
+
 To get TYPO3, navigate to the following location:
-         http://typo3.org/download/packages/
+       http://typo3.org/download/packages/
 
 TYPO3 consists of two packages: source and dummy. The source package contains
 files that are the same for every TYPO3 web site. The dummy package contains
@@ -67,16 +93,19 @@ files unique to each TYPO3 installation.
 
 To install TYPO3, both packages must be downloaded.
 
+
+===============================================================================
 Installation: simple (not recommended!)
-=======================================
+===============================================================================
+
 This procedure is not recommended because it makes upgrades harder. However, it
 can be the only option if you hosting company does not provide SSH access to
 the web server.
 
 To install TYPO3, unpack the source package locally. Unpacking will produce a
 directory with a name like typo3_src-x.y.z, where x, y and z correspond to the
-TYPO3 version. For example, the TYPO3 4.3.0 source package will create a
-directory named typo3_src-4.3.0.
+TYPO3 version. For example, the TYPO3 x.y.z source package will create a
+directory named typo3_src-x.y.z.
 
 Next unpack the dummy package. This will create a directory with the name
 dummy-x.y.z. Now create a new directory and copy all files and folders from
@@ -87,20 +116,23 @@ the web server.
 
 Change permissions of the directories and files. The following directories and
 files should be read-only for the web server:
-           t3lib/
-           typo3/
-           index.php
+       t3lib/
+       typo3/
+       index.php
 
 All other directories should be writable for the web server. If in doubt,
 contact your hosting company and ask them to assist in adjusting permissions.
 
+
+===============================================================================
 Installation: recommended
-=========================
+===============================================================================
+
 To install TYPO3, unpack the source package outside of the web site root
 directory on your server. The location must be accessible to the web server.
 Unpacking will produce a directory with a name like typo3_src-x.y.z, where x,
-y and z correspond to the TYPO3 version. For example, the TYPO3 4.3.0 source
-package will create a directory named typo3_src-4.3.0.
+y and z correspond to the TYPO3 version. For example, the TYPO3 4.6.0 source
+package will create a directory named typo3_src-4.6.0.
 
 Unpack the dummy package in the temporary location on the server. This will
 create a dummy-x.y.z directory. Move all files and directories from the
@@ -108,31 +140,31 @@ dummy-x.y.z directory to the web site root directory.
 
 Linux, Unix and Mac OS X users should use the tar.gz packages and unpack them
 using:
-          tar xzf source-x.y.z
-          tar xzf dummy-x.y.z
+       tar xzf source-x.y.z
+       tar xzf dummy-x.y.z
 
 Windows users can use Windows built-in unpacker on unpack ZIP versions of
 packages.
 
 On Linux, Unix or Mac OS X systems create a symbolic link named typo3_src
 pointing to the source package:
-          ln -s /var/www/typo3_src-4.3.0 /var/www/example.com/typo3_src
+       ln -s /var/www/typo3_src-4.6.0 /var/www/example.com/typo3_src
 
 On Windows Vista or Windows 7 create a symbolic link named typo3_src
 pointing to the source package:
-          mklink /D C:\<dir>\typo3_src-4.3.0 C:\<dir>\example.com\typo3_src
+       mklink /D C:\<dir>\typo3_src-4.6.0 C:\<dir>\example.com\typo3_src
 
-Users of Windows XP/2000 can use the "junction" program by Marc Russinovich to
-create links. The program can be obtained at:
-          http://technet.microsoft.com/en-us/sysinternals/bb896768.aspx
+Users of Windows XP/2000 or newer can use the "junction" program by
+Marc Russinovich to create links. The program can be obtained at:
+       http://technet.microsoft.com/en-us/sysinternals/bb896768.aspx
 
 Next create links for the typo3/ and t3lib/ directories:
-          cd /var/www/example.com
-          ln -s typo3_src/t3lib
-          ln -s typo3_src/typo3
+cd /var/www/example.com
+       ln -s typo3_src/t3lib
+       ln -s typo3_src/typo3
 
 Linux, Unix and Mac OS X users also create a symbolic link to index.php
-          ln -s typo3_src/index.php
+       ln -s typo3_src/index.php
 
 Windows users must copy index.php from the source directory to the web site
 root directory because Windows does not support links for files.
@@ -140,45 +172,72 @@ root directory because Windows does not support links for files.
 Change permissions and ownership of the directories. This usually requires the
 "sudo" command. Assuming that the web server user is in the group named
 "apache", execute the following commands in the web site root directory:
-          sudo chgrp -R apache fileadmin typo3temp typo3conf uploads
-          sudo chmod g+rwX,o-w fileadmin typo3temp typo3conf uploads
+       sudo chgrp -R apache fileadmin typo3temp typo3conf uploads
+       sudo chmod -R g+rwX,o-w fileadmin typo3temp typo3conf uploads
 
 If "sudo" is not available, ask your hosting company to change the permissions.
 
+
+===============================================================================
 Setting up TYPO3
-================
+===============================================================================
+
 To set up TYPO3, navigate to your web site. The TYPO3 installer will run in the
 1-2-3 mode to easily guide you through the installation.
 
+
+===============================================================================
 Troubleshooting
-===============
+===============================================================================
+
 For troubleshooting read the FAQ below. If your problem is not listed, feel
-free to ask questions in the TYPO3 mailing lists.
+free to ask questions in the TYPO3 mailing lists:
+       http://typo3.org/community/mailing-lists/
+
 
+===============================================================================
 FAQ
-===
-Q: Why do I get "500 Server error" when I navigate to my TYPO3 web site
-  immediately after installation?
-A: Make sure that AllowOverride allows "Indexes" in the Apache configuration.
-  If you cannot ensure this, rename .htaccess files to _.htaccess. TYPO3 will
-  run but considerably slower. Here is the list of the files to rename:
-           typo3/contrib/.htaccess
-           typo3/gfx/.htaccess
-           typo3/mod/user/ws/.htaccess
-           typo3/sysext/.htaccess
-           typo3/sysext/t3skin/stylesheets/.htaccess
-  If the error does not disappear, web server error logs should help. For
-  Apache, the error log is usually located in /var/log/apache2 or
-  /var/log/httpd. Check with your hosting provider if you are in doubt where
-  the logs are located.
-
-Q: I went through the setup process and created an admin user. Why can't I log
-  in now?
-A: If you use MySQL 5.x or newer, try setting it to "compatible" mode. Open the
-  TYPO3 Install tool under http://example.com/typo3/install/ (where example.com
-  is the web site domain), navigate to "All configuration". find "setDBinit",
-  and add this line to the top of the input field:
-           SET SESSION sql_mode='MYSQL40'
-
-
-SVN document information: $Id: $
\ No newline at end of file
+===============================================================================
+
+Q:     Why do I get "500 Server error" when I navigate to my TYPO3 web site
+       immediately after installation?
+A:     Make sure that AllowOverride allows "Indexes" and "FileInfo" in the Apache
+       configuration. If you cannot ensure this, rename .htaccess files to
+       _.htaccess. TYPO3 will run but considerably slower.
+       Here is the list of the files to rename:
+               typo3/contrib/.htaccess
+               typo3/gfx/.htaccess
+               typo3/mod/user/ws/.htaccess
+               typo3/sysext/.htaccess
+               typo3/sysext/t3skin/stylesheets/.htaccess
+       If the error does not disappear, web server error logs should help. For
+       Apache, the error log is usually located in /var/log/apache2 or
+       /var/log/httpd. Check with your hosting provider if you are in doubt where
+       the logs are located.
+
+Q:     Backend or Installer looks strange, no images just black and white?
+A:     Maybe you missed some configuration in your .htaccess file.
+       Have a look at typo3_src/misc/advanced.htaccess to find the options
+       you might need.
+
+Q:     I went through the setup process and created an admin user. Why can't I log
+       in now?
+A:     If you use MySQL 5.x or newer, try setting it to "compatible" mode. Open the
+       TYPO3 Install tool under http://example.com/typo3/install/ (where example.com
+       is the web site domain), navigate to "All configuration". find "setDBinit",
+       and add this line to the top of the input field:
+               SET SESSION sql_mode='MYSQL40'
+
+Q:     What do I have to do regarding security?
+A:     You have to make sure that you keep your TYPO3-core and the extensions
+       up to date.
+       * Subscribe to the announcement mailing list. This will inform you about new
+         releases of the TYPO3 core and security bulletins of core and community
+         extensions.
+         http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-announce
+       * Use the scheduler task "Update Extension List (em)" to update the list of
+         available extensions regularly. You should check regularly, if new versions
+         of these extensions are available and install them respectively.
+       * For further reading regarding securing TYPO3, please read the TYPO3 security
+         cookbook and other resources. Please visit
+         http://typo3.org/teams/security/resources/