[BUGFIX] Use correct path variable on Windows
[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   * SPL
78   * standard
79   * xml
80   * zip
81   * zlib
82
83 * These might have to be installed separately:
84   * gd
85   * json
86   * mysqli
87
88 ### Recommended setup
89
90 There are plenty of possible setups for high performance TYPO3 installations
91 (i.e. using Varnish Cache, Nginx, PHP-FPM, etc). Consider this resource for
92 more ideas or suggestions:  http://wiki.typo3.org/Performance_tuning
93
94 This is a basic recommended setup for best performance and increased
95 functionality:
96
97 * Apache with mod_expires and mod_rewrite enabled
98
99 * MySQL 5.5 or newer
100
101 * GraphicsMagick or ImageMagick v6 or newer installed on the server
102
103 * PHP
104   * version 7.0 or later
105   * memory_limit set to at least 128M
106   * max_execution_time set to at least 240
107   * max_input_vars set to at least 1500
108
109 * Additional PHP extensions:
110   * PHP opcode cache, i.e.: apc, xcache, eaccelerator, Zend Optimizer, wincache (in case of an IIS installation)
111   * apcu caching (with at least 100 MB of memory available)
112   * curl
113   * mbstring
114   * FreeType 2 (usually included within the PHP distribution)
115   * bcmath or gmp (needed if you'd like to use the openid system extension)
116   * fileinfo (mandatory for proper file type detection)
117
118 * PHP access to /dev/urandom or /dev/random on Unix-like platforms for
119   increased security. Make sure to add "/dev/random:/dev/urandom" to
120   open_basedir settings if you use it. If these paths are unavailable, TYPO3
121   will attempt to simulate random number generation. This is less secure,
122   reduces performance and throws out warnings in the TYPO3 system log.
123
124 * TYPO3 works with PHP's IPv6 support, which is enabled by default.
125   If you compile PHP on your own, be aware not to use option "--disable-ipv6",
126   because this will break the IPv6 support and the according unit tests.
127
128 Installation
129 ------------
130
131 ### Important note for upgrades from TYPO3 CMS versions **below 7 LTS**
132
133 It is not possible to upgrade any version below 7 LTS to 8 directly,
134 since some upgrade wizards are not available anymore on 8.
135
136 It is highly recommended to upgrade to 7 LTS first and continue with
137 a second upgrade to 8.
138
139 ### If SSH and symlinks are possible
140
141 If you have SSH access to your webserver and are able to create symlinks,
142 this is the recommended way of setting up TYPO3 so that it can easily
143 be upgraded later through the Install Tool:
144
145 * Uncompress the `typo3_src-8.x.x.tar.gz` file one level above the Document
146   Root of your Web server:
147 ```
148 /var/www/site/htdocs/ $ cd ..
149 /var/www/site/ $ tar xzf typo3_src-8.x.x.tar.gz
150 ```
151
152 * Important: If you use GIT to fetch the sources, don't forget to run the following commands,
153 otherwise your installation won't work!
154 ```
155 cd typo3_src
156 composer install --no-dev
157 cd ..
158 ```
159
160 * Create the symlinks in your Document Root:
161 ```
162   cd htdocs
163   ln -s ../typo3_src-8.x.x typo3_src
164   ln -s typo3_src/index.php
165   ln -s typo3_src/typo3
166 ```
167
168 * In case you use Apache, copy the .htaccess to your Document Root:
169 ```
170   cp typo3_src/_.htaccess .htaccess
171 ```
172
173 * In case you use IIS, install the URL Rewrite 2.x module and copy the web.config to your Document Root:
174 ```
175   cp typo3_src/_web.config web.config
176 ```
177
178 You end up with the follow structure of files:
179
180 ```
181   typo3_src-8.x.x/
182   htdocs/typo3_src -> ../typo3_src-8.x.x/
183   htdocs/typo3 -> typo3_src/typo3/
184   htdocs/index.php -> typo3_src/index.php
185   htdocs/.htaccess (only on Apache)
186   htdocs/web.config (only on IIS)
187 ```
188
189 This allows you to upgrade TYPO3 later by simply replacing the symlink
190 with a newer version, or by using the integrated "Core Updater" which can
191 be found in the Install Tool.
192
193 ### Windows specifics
194
195 #### Symlinks
196
197 On Windows Vista and newer you can create symbolic links using the `mklink` tool:
198 ```
199   mklink /D C:\<dir>\example.com\typo3_src C:\<dir>\typo3_src-8.x.x
200   mklink C:\<dir>\example.com\index.php C:\<dir>\typo3_src-8.x.x\index.php
201 ```
202
203 Windows users might need to copy `index.php` from the source directory to the
204 web site root directory in case the Windows version does not support links
205 for files.
206
207 TYPO3 Core upgrades through the Install Tool is not supported under
208 Windows.
209
210 #### Path length
211
212 Up until PHP 7.0 Windows has had problems with lengths of a path.
213 The TYPO3 core enforces a maximum path length of 160 characters in itself, leaving
214 100 characters for your installation directory. Please note that these 100 characters
215 are counted including the drive identifier (C:\ for example).
216
217 In case you use composer to install your TYPO3 instance, be aware that composer will
218 try to unpack TYPO3 into composer's cache dir first and then move the files to your
219 target directory.
220 Because composer's cache dir defaults to C:\Users\<user>\AppData\Local\Composer it is
221 possible your full path becomes more than the 100 characters you're allowed to use.
222
223 You can use the `cache-dir` directive to set a shorter directory specifically for
224 your TYPO3 instance.
225
226 See: https://getcomposer.org/doc/06-config.md#cache-dir
227
228 ### No SSH and symlinks possible (not recommended)
229
230 In case you only have FTP or SFTP access to your hosting environment, you
231 can still install TYPO3, but you won't easily be able to upgrade your
232 installation once a new patch-level release is out.
233
234 Please note that this is not a recommended setup!
235
236 * Uncompress `typo3_src-8.x.x.zip` locally
237 * Upload all files and subdirectories directly in your Document Root
238   (where files that are served by your webserver are located).
239 * In case your provider uses Apache, rename the file `_.htaccess` to `.htaccess`.
240 * In case your provider uses IIS, rename the file `_web.config` to `web.config`.
241
242 You end up with this files in your Document Root:
243
244 ```
245  .htaccess (only on Apache)
246  web.config (only on IIS)
247  CONTRIBUTING.md
248  index.php
249  INSTALL.md
250  LICENSE.txt
251  README.md
252  typo3/
253 ```
254
255 Installation: further steps
256 ---------------------------
257
258 Now access the web server using a web browser. You will be redirected to the
259 Install Tool which will walk you through the steps for setting up TYPO3 for
260 the first time.
261
262 It will check if your environment conforms to the minimum system requirements
263 and gives you some suggestions on what to change in case there are any
264 discrepancies.
265
266 The Install Tool will create the required directory structure for you
267 (typo3conf, uploads, fileadmin, typo3temp).
268
269 TYPO3 Security
270 --------------
271
272 To ensure a secure installation, you have to make sure that you keep your
273 TYPO3 core and the extensions up to date.
274
275 * Subscribe to the announcement mailing list. This will inform you about new
276   releases of the TYPO3 core and security bulletins of core and community
277   extensions.
278   http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-announce
279
280 * Use the scheduler task "Update Extension List (em)" to update the list of
281   available extensions regularly. You should check regularly, if new versions
282   of these extensions are available and apply these updates.
283
284 * Please refer to official TYPO3 Security Guide for further information
285   about security-related topics of TYPO3 CMS and the resources compiled by
286   the Security Team.
287   https://docs.typo3.org/typo3cms/SecurityGuide/
288   https://typo3.org/teams/security/resources/
289
290 Installation FAQ
291 ----------------
292
293 ### 1
294 Q:  Why do I get "500 Server error" when I navigate to my TYPO3 web site
295     immediately after installation?
296
297 A:  If you are using Apache web server, check the Apache error log for specifics
298     on the error. The cause might be some missing module, or some syntax error
299     in your .htaccess file. The error log is usually located in /var/log/apache2
300     or /var/log/httpd. Check with your hosting provider if you are in doubt
301     where the logs are located.
302
303 ### 2
304 Q:  I went through the setup process and created an admin user. Why can't I log
305     in now?
306
307 A:  If you use MySQL 5.x or newer, try setting it to "compatible" mode. Open the
308     TYPO3 Install Tool under http://example.com/typo3/install/ (where
309     example.com is the web site domain), navigate to "All configuration".
310     Find "setDBinit", and add this line to the top of the input field:
311 ```
312         SET SESSION sql_mode=''
313 ```
314
315 ### 3
316 Q:  Some modules or extensions make Apache crash on Windows. What is the cause?
317
318 A:  Fluid uses complex regular expressions which require a lot of stack space
319     during the first processing. On Windows the default stack size for Apache
320     is a lot smaller than on unix. You can increase the size to 8MB (default on
321     unix) by adding to the httpd.conf:
322 ```
323         <IfModule mpm_winnt_module>
324                 ThreadStackSize 8388608
325         </IfModule>
326 ```
327     Restart Apache after this change.