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