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