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