[BUGFIX] Fix DB error handling in FrontendUserImageUpdateWizard
[Packages/TYPO3.CMS.git] / INSTALL.md
1 INSTALLING TYPO3
2 ================
3
4 TYPO3 is an open source PHP based web content management system released
5 under the GNU GPL. TYPO3 is copyright (c) 1999-2016 by Kasper Skaarhoj.
6
7 This document describes:
8
9 * System requirements for TYPO3
10 * Installation routine
11 * Upgrade routine
12
13 Client browser support
14 ----------------------
15
16 The TYPO3 backend is accessed through a web browser. TYPO3 v8
17 supports the following web browsers:
18
19 * Internet Explorer 11 and later
20 * Microsoft Edge
21 * Google Chrome (Windows, MacOS X, Linux)
22 * Firefox (Windows, MacOS X, Linux)
23 * Safari on MacOS X
24 * and other compatible modern browsers
25
26 Server system requirements
27 --------------------------
28
29 TYPO3 requires a web server with a PHP environment and a database. The minimum
30 system requirements for running TYPO3 v8 are:
31
32 * Webserver capable of running PHP applications (Apache, Nginx, IIS or other)
33 * PHP 7
34 * MySQL 5.5 up to 5.7 or compatible
35 * more than 200 MB of disk space
36
37 Note: If you use any other webserver than Apache, make sure you add the necessary configuration normally
38 provided in the various `.htaccess` files inside the TYPO3 core. This configuration is security relevant,
39 therefore only experienced server administrators should create such configuration.
40
41 ### MySQL environment
42
43 TYPO3 works with MySQL in the above mentioned versions. It will also work on
44 compatible "drop-in" replacements like MariaDB or Percona. The InnoDB engine
45 is required to be enabled.
46
47 ### MySQL required privileges
48
49 The MySQL user needs a least the following privileges on the TYPO3 database:
50
51 * SELECT, INSERT, UPDATE, DELETE
52 * CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES
53
54 It is recommended to also grant the following privileges:
55
56 * CREATE VIEW, SHOW VIEW
57 * EXECUTE, CREATE ROUTINE, ALTER ROUTINE
58
59 ### PHP environment
60
61 * memory_limit set to at least 64M
62 * max_execution_time set to at least 30 (240 seconds recommended)
63 * AllowOverride in the Apache configuration includes "Indexes" and "FileInfo"
64   (see FAQ below)
65
66 ### PHP required extensions
67
68 Your PHP needs to support the following extensions. Install will
69 check if these are available.
70
71 * These are usually part of the standard PHP package on most distributions:
72   * filter
73   * hash
74   * openssl
75   * pcre >= 8.38
76   * session
77   * soap
78   * SPL
79   * standard
80   * xml
81   * zip
82   * zlib
83
84 * These might have to be installed separately:
85   * gd
86   * json
87   * mysqli
88
89 ### Recommended setup
90
91 There are plenty of possible setups for high performance TYPO3 installations
92 (i.e. using Varnish Cache, Nginx, PHP-FPM, etc). Consider this resource for
93 more ideas or suggestions:  http://wiki.typo3.org/Performance_tuning
94
95 This is a basic recommended setup for best performance and increased
96 functionality:
97
98 * Apache with mod_expires and mod_rewrite enabled
99
100 * MySQL 5.5 or newer
101
102 * GraphicsMagick or ImageMagick v6 or newer installed on the server
103
104 * PHP
105   * version 7.0 or later
106   * memory_limit set to at least 128M
107   * max_execution_time set to at least 240
108   * max_input_vars set to at least 1500
109
110 * Additional PHP extensions:
111   * PHP opcode cache, i.e.: apc, xcache, eaccelerator, Zend Optimizer, wincache (in case of an IIS installation)
112   * apcu caching (with at least 100 MB of memory available)
113   * curl
114   * mbstring
115   * FreeType 2 (usually included within the PHP distribution)
116   * bcmath or gmp (needed if you'd like to use the openid system extension)
117   * fileinfo (mandatory for proper file type detection)
118
119 * PHP access to /dev/urandom or /dev/random on Unix-like platforms for
120   increased security. Make sure to add "/dev/random:/dev/urandom" to
121   open_basedir settings if you use it. If these paths are unavailable, TYPO3
122   will attempt to simulate random number generation. This is less secure,
123   reduces performance and throws out warnings in the TYPO3 system log.
124
125 * TYPO3 works with PHP's IPv6 support, which is enabled by default.
126   If you compile PHP on your own, be aware not to use option "--disable-ipv6",
127   because this will break the IPv6 support and the according unit tests.
128
129 Installation
130 ------------
131
132 ### Important note for upgrades from TYPO3 CMS versions **below 7 LTS**
133
134 It is not possible to upgrade any version below 7 LTS to 8 directly,
135 since some upgrade wizards are not available anymore on 8.
136
137 It is highly recommended to upgrade to 7 LTS first and continue with
138 a second upgrade to 8.
139
140 ### If SSH and symlinks are possible
141
142 If you have SSH access to your webserver and are able to create symlinks,
143 this is the recommended way of setting up TYPO3 so that it can easily
144 be upgraded later through the Install Tool:
145
146 * Uncompress the `typo3_src-8.x.x.tar.gz` file one level above the Document
147   Root of your Web server:
148 ```
149 /var/www/site/htdocs/ $ cd ..
150 /var/www/site/ $ tar xzf typo3_src-8.x.x.tar.gz
151 ```
152
153 * Important: If you use GIT to fetch the sources, don't forget to run the following commands,
154 otherwise your installation won't work!
155 ```
156 cd typo3_src
157 composer install --no-dev
158 cd ..
159 ```
160
161 * Create the symlinks in your Document Root:
162 ```
163   cd htdocs
164   ln -s ../typo3_src-8.x.x typo3_src
165   ln -s typo3_src/index.php
166   ln -s typo3_src/typo3
167 ```
168
169 * In case you use Apache, copy the .htaccess to your Document Root:
170 ```
171   cp typo3_src/_.htaccess .htaccess
172 ```
173
174 You end up with the follow structure of files:
175
176 ```
177   typo3_src-8.x.x/
178   htdocs/typo3_src -> ../typo3_src-8.x.x/
179   htdocs/typo3 -> typo3_src/typo3/
180   htdocs/index.php -> typo3_src/index.php
181   htdocs/.htaccess
182 ```
183
184 This allows you to upgrade TYPO3 later by simply replacing the symlink
185 with a newer version, or by using the integrated "Core Updater" which can
186 be found in the Install Tool.
187
188 ### Windows specifics
189
190 On Windows Vista and newer you can create symbolic links using the `mklink` tool:
191 ```
192   mklink /D C:\<dir>\example.com\typo3_src C:\<dir>\typo3_src-8.x.x
193   mklink C:\<dir>\example.com\index.php C:\<dir>\typo3_src-8.x.x\index.php
194 ```
195
196 Windows users might need to copy `index.php` from the source directory to the
197 web site root directory in case the Windows version does not support links
198 for files.
199
200 TYPO3 Core upgrades through the Install Tool is not supported under
201 Windows.
202
203 ### No SSH and symlinks possible (not recommended)
204
205 In case you only have FTP or SFTP access to your hosting environment, you
206 can still install TYPO3, but you won't easily be able to upgrade your
207 installation once a new patch-level release is out.
208
209 Please note that this is not a recommended setup!
210
211 * Uncompress `typo3_src-8.x.x.zip` locally
212 * Upload all files and subdirectories directly in your Document Root
213   (where files that are served by your webserver are located).
214 * In case your provider uses Apache, rename the file `_.htaccess` to `.htaccess`.
215
216 You end up with this files in your Document Root:
217
218 ```
219  .htaccess
220  ChangeLog
221  GPL.txt
222  index.php
223  INSTALL.md
224  LICENSE.txt
225  NEWS.txt
226  README.md
227  typo3/
228 ```
229
230 Installation: further steps
231 ---------------------------
232
233 Now access the web server using a web browser. You will be redirected to the
234 Install Tool which will walk you through the steps for setting up TYPO3 for
235 the first time.
236
237 It will check if your environment conforms to the minimum system requirements
238 and gives you some suggestions on what to change in case there are any
239 discrepancies.
240
241 The Install Tool will create the required directory structure for you
242 (typo3conf, uploads, fileadmin, typo3temp).
243
244 TYPO3 Security
245 --------------
246
247 To ensure a secure installation, you have to make sure that you keep your
248 TYPO3 core and the extensions up to date.
249
250 * Subscribe to the announcement mailing list. This will inform you about new
251   releases of the TYPO3 core and security bulletins of core and community
252   extensions.
253   http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-announce
254
255 * Use the scheduler task "Update Extension List (em)" to update the list of
256   available extensions regularly. You should check regularly, if new versions
257   of these extensions are available and apply these updates.
258
259 * Please refer to official TYPO3 Security Guide for further information
260   about security-related topics of TYPO3 CMS and the resources compiled by
261   the Security Team.
262   https://docs.typo3.org/typo3cms/SecurityGuide/
263   https://typo3.org/teams/security/resources/
264
265 Installation FAQ
266 ----------------
267
268 ### 1
269 Q:  Why do I get "500 Server error" when I navigate to my TYPO3 web site
270     immediately after installation?
271
272 A:  If you are using Apache web server, check the Apache error log for specifics
273     on the error. The cause might be some missing module, or some syntax error
274     in your .htaccess file. The error log is usually located in /var/log/apache2
275     or /var/log/httpd. Check with your hosting provider if you are in doubt
276     where the logs are located.
277
278 ### 2
279 Q:  I went through the setup process and created an admin user. Why can't I log
280     in now?
281
282 A:  If you use MySQL 5.x or newer, try setting it to "compatible" mode. Open the
283     TYPO3 Install Tool under http://example.com/typo3/install/ (where
284     example.com is the web site domain), navigate to "All configuration".
285     Find "setDBinit", and add this line to the top of the input field:
286 ```
287         SET SESSION sql_mode=''
288 ```
289
290 ### 3
291 Q:  Some modules or extensions make Apache crash on Windows. What is the cause?
292
293 A:  Fluid uses complex regular expressions which require a lot of stack space
294     during the first processing. On Windows the default stack size for Apache
295     is a lot smaller than on unix. You can increase the size to 8MB (default on
296     unix) by adding to the httpd.conf:
297 ```
298         <IfModule mpm_winnt_module>
299                 ThreadStackSize 8388608
300         </IfModule>
301 ```
302     Restart Apache after this change.