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