INSTALL.txt

   1                              INSTALL
   2
   3 This document is a part of the TYPO3 project. TYPO3 is an open source web
   4 content management system released under the GNU GPL. TYPO3 is copyright
   5 (c) 1999-2009 by Kasper Skaarhoj.
   6
   7 This document describes the system requirements for TYPO3 and the installation
   8 routine.
   9
  10 System requirements
  11 ===================
  12 TYPO3 requires a web server with a PHP installation and a database. While TYPO3
  13 can be configured to run on many web servers with different databases, this
  14 document assumes that Apache and MySQL will be used. This document does not
  15 cover using TYPO3 with other databases or web servers.
  16
  17 The following configuration is the minimum required:
  18 - a web server capable of running PHP
  19 - PHP 5.2.0 or newer with the following extensions:
  20  - filter
  21  - GD2
  22  - JSON
  23  - mysql
  24  - pcre
  25  - session
  26  - SPL
  27  - standard
  28  - xml
  29  Some extensions can be optionally compiled into PHP. A list of loaded
  30  extensions can be checked using the phpinfo() function.
  31 - memory_limit set to at least to 64M in php.ini
  32 - MySQL 4.1 or newer
  33 - 200 MB of disk space
  34 - AllowOverride in the Apache configuration includes "Indexes" (see FAQ below)
  35
  36 The following configuration is recommended:
  37 - Apache 2.x
  38 - mod_expires and mod_rewrite enabled in the Apache configuration
  39 - PHP 5.2.0 or newer with the following extensions:
  40  - cURL
  41  - filter
  42  - GD2
  43  - JSON
  44  - mbstring
  45  - mysql
  46  - pcre
  47  - session
  48  - SPL
  49  - standard
  50  - xml
  51  Some extensions can be optionally compiled into PHP. A list of loaded
  52  extensions can be checked using the phpinfo() function.
  53 - memory_limit set to 128M or more in php.ini
  54 - MySQL 5.1 or newer
  55 - GraphicsMagick
  56 - 200 MB or more of disk space
  57 - AllowOverride in the Apache configuration includes "Indexes" (see FAQ below)
  58
  59 Obtaining TYPO3
  60 ===============
  61 To get TYPO3, navigate to the following location:
  62          http://typo3.org/download/packages/
  63
  64 TYPO3 consists of two packages: source and dummy. The source package contains
  65 files that are the same for every TYPO3 web site. The dummy package contains
  66 files unique to each TYPO3 installation.
  67
  68 To install TYPO3, both packages must be downloaded.
  69
  70 Installation: simple (not recommended!)
  71 =======================================
  72 This procedure is not recommended because it makes upgrades harder. However, it
  73 can be the only option if you hosting company does not provide SSH access to
  74 the web server.
  75
  76 To install TYPO3, unpack the source package locally. Unpacking will produce a
  77 directory with a name like typo3_src-x.y.z, where x, y and z correspond to the
  78 TYPO3 version. For example, the TYPO3 4.3.0 source package will create a
  79 directory named typo3_src-4.3.0.
  80
  81 Next unpack the dummy package. This will create a directory with the name
  82 dummy-x.y.z. Now create a new directory and copy all files and folders from
  83 within typo3_src-x.y.z and dummy-x.y.z into this new directory.
  84
  85 Use a FTP or SFTP program or any other available way to upload all files to
  86 the web server.
  87
  88 Change permissions of the directories and files. The following directories and
  89 files should be read-only for the web server:
  90            t3lib/
  91            typo3/
  92            index.php
  93
  94 All other directories should be writable for the web server. If in doubt,
  95 contact your hosting company and ask them to assist in adjusting permissions.
  96
  97 Installation: recommended
  98 =========================
  99 To install TYPO3, unpack the source package outside of the web site root
 100 directory on your server. The location must be accessible to the web server.
 101 Unpacking will produce a directory with a name like typo3_src-x.y.z, where x,
 102 y and z correspond to the TYPO3 version. For example, the TYPO3 4.3.0 source
 103 package will create a directory named typo3_src-4.3.0.
 104
 105 Unpack the dummy package in the temporary location on the server. This will
 106 create a dummy-x.y.z directory. Move all files and directories from the
 107 dummy-x.y.z directory to the web site root directory.
 108
 109 Linux, Unix and Mac OS X users should use the tar.gz packages and unpack them
 110 using:
 111           tar xzf source-x.y.z
 112           tar xzf dummy-x.y.z
 113
 114 Windows users can use Windows built-in unpacker on unpack ZIP versions of
 115 packages.
 116
 117 On Linux, Unix or Mac OS X systems create a symbolic link named typo3_src
 118 pointing to the source package:
 119           ln -s /var/www/typo3_src-4.3.0 /var/www/example.com/typo3_src
 120
 121 On Windows Vista or Windows 7 create a symbolic link named typo3_src
 122 pointing to the source package:
 123           mklink /D C:\<dir>\typo3_src-4.3.0 C:\<dir>\example.com\typo3_src
 124
 125 Users of Windows XP/2000 can use the "junction" program by Marc Russinovich to
 126 create links. The program can be obtained at:
 127           http://technet.microsoft.com/en-us/sysinternals/bb896768.aspx
 128
 129 Next create links for the typo3/ and t3lib/ directories:
 130           cd /var/www/example.com
 131           ln -s typo3_src/t3lib
 132           ln -s typo3_src/typo3
 133
 134 Linux, Unix and Mac OS X users also create a symbolic link to index.php
 135           ln -s typo3_src/index.php
 136
 137 Windows users must copy index.php from the source directory to the web site
 138 root directory because Windows does not support links for files.
 139
 140 Change permissions and ownership of the directories. This usually requires the
 141 "sudo" command. Assuming that the web server user is in the group named
 142 "apache", execute the following commands in the web site root directory:
 143           sudo chgrp -R apache fileadmin typo3temp typo3conf uploads
 144           sudo chmod g+rwX,o-w fileadmin typo3temp typo3conf uploads
 145
 146 If "sudo" is not available, ask your hosting company to change the permissions.
 147
 148 Setting up TYPO3
 149 ================
 150 To set up TYPO3, navigate to your web site. The TYPO3 installer will run in the
 151 1-2-3 mode to easily guide you through the installation.
 152
 153 Troubleshooting
 154 ===============
 155 For troubleshooting read the FAQ below. If your problem is not listed, feel
 156 free to ask questions in the TYPO3 mailing lists.
 157
 158 FAQ
 159 ===
 160 Q: Why do I get "500 Server error" when I navigate to my TYPO3 web site
 161   immediately after installation?
 162 A: Make sure that AllowOverride allows "Indexes" in the Apache configuration.
 163   If you cannot ensure this, rename .htaccess files to _.htaccess. TYPO3 will
 164   run but considerably slower. Here is the list of the files to rename:
 165            typo3/contrib/.htaccess
 166            typo3/gfx/.htaccess
 167            typo3/mod/user/ws/.htaccess
 168            typo3/sysext/.htaccess
 169            typo3/sysext/t3skin/stylesheets/.htaccess
 170   If the error does not disappear, web server error logs should help. For
 171   Apache, the error log is usually located in /var/log/apache2 or
 172   /var/log/httpd. Check with your hosting provider if you are in doubt where
 173   the logs are located.
 174
 175 Q: I went through the setup process and created an admin user. Why can't I log
 176   in now?
 177 A: If you use MySQL 5.x or newer, try setting it to "compatible" mode. Open the
 178   TYPO3 Install tool under http://example.com/typo3/install/ (where example.com
 179   is the web site domain), navigate to "All configuration". find "setDBinit",
 180   and add this line to the top of the input field:
 181            SET SESSION sql_mode='MYSQL40'
 182
 183
 184 SVN document information: $Id: $