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.
7 This document describes:
9 * System requirements for TYPO3
10 * Installation routine
13 Client browser support
14 ----------------------
16 The TYPO3 backend is accessed through a web browser. TYPO3 v8
17 supports the following web browsers:
19 * Internet Explorer 11 and later
21 * Google Chrome (Windows, MacOS X, Linux)
22 * Firefox (Windows, MacOS X, Linux)
24 * and other compatible modern browsers
26 Server system requirements
27 --------------------------
29 TYPO3 requires a web server with a PHP environment and a database. The minimum
30 system requirements for running TYPO3 v8 are:
32 * Webserver capable of running PHP applications (Apache, Nginx, IIS or other)
34 * MySQL 5.5 up to 5.7 or compatible
35 * more than 200 MB of disk space
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.
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.
47 ### MySQL required privileges
49 The MySQL user needs a least the following privileges on the TYPO3 database:
51 * SELECT, INSERT, UPDATE, DELETE
52 * CREATE, DROP, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES
54 It is recommended to also grant the following privileges:
56 * CREATE VIEW, SHOW VIEW
57 * EXECUTE, CREATE ROUTINE, ALTER ROUTINE
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"
66 ### PHP required extensions
68 Your PHP needs to support the following extensions. Install will
69 check if these are available.
71 * These are usually part of the standard PHP package on most distributions:
83 * These might have to be installed separately:
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
94 This is a basic recommended setup for best performance and increased
97 * Apache with mod_expires and mod_rewrite enabled
101 * GraphicsMagick or ImageMagick v6 or newer installed on the server
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
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)
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)
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.
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.
131 ### Important note for upgrades from TYPO3 CMS versions **below 7 LTS**
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.
136 It is highly recommended to upgrade to 7 LTS first and continue with
137 a second upgrade to 8.
139 ### If SSH and symlinks are possible
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:
145 * Uncompress the `typo3_src-8.x.x.tar.gz` file one level above the Document
146 Root of your Web server:
148 /var/www/site/htdocs/ $ cd ..
149 /var/www/site/ $ tar xzf typo3_src-8.x.x.tar.gz
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!
156 composer install --no-dev
160 * Create the symlinks in your Document Root:
163 ln -s ../typo3_src-8.x.x typo3_src
164 ln -s typo3_src/index.php
165 ln -s typo3_src/typo3
168 * In case you use Apache, copy the .htaccess to your Document Root:
170 cp typo3_src/_.htaccess .htaccess
173 * In case you use IIS, install the URL Rewrite 2.x module and copy the web.config to your Document Root:
175 cp typo3_src/_web.config web.config
178 You end up with the follow structure of files:
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)
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.
193 ### Windows specifics
197 On Windows Vista and newer you can create symbolic links using the `mklink` tool:
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
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
207 TYPO3 Core upgrades through the Install Tool is not supported under
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).
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
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.
223 You can use the `cache-dir` directive to set a shorter directory specifically for
226 See: https://getcomposer.org/doc/06-config.md#cache-dir
228 ### No SSH and symlinks possible (not recommended)
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.
234 Please note that this is not a recommended setup!
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`.
242 You end up with this files in your Document Root:
245 .htaccess (only on Apache)
246 web.config (only on IIS)
255 Installation: further steps
256 ---------------------------
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
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
266 The Install Tool will create the required directory structure for you
267 (typo3conf, uploads, fileadmin, typo3temp).
272 To ensure a secure installation, you have to make sure that you keep your
273 TYPO3 core and the extensions up to date.
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
278 http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-announce
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.
284 * Please refer to official TYPO3 Security Guide for further information
285 about security-related topics of TYPO3 CMS and the resources compiled by
287 https://docs.typo3.org/typo3cms/SecurityGuide/
288 https://typo3.org/teams/security/resources/
294 Q: Why do I get "500 Server error" when I navigate to my TYPO3 web site
295 immediately after installation?
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.
304 Q: I went through the setup process and created an admin user. Why can't I log
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:
312 SET SESSION sql_mode=''
316 Q: Some modules or extensions make Apache crash on Windows. What is the cause?
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:
323 <IfModule mpm_winnt_module>
324 ThreadStackSize 8388608
327 Restart Apache after this change.