Project

General

Profile

Bug #16203 ยป INSTALL.txt

Administrator Admin, 2006-05-30 19:23

 

INSTALL

This document is a part of TYPO3 project. TYPO3 is the open source web content
management system released under GNU GPL. TYPO3 is copyright (c) 1999-2008
by Kasper Skaarhoj.

This document describes system requirements for TYPO3 and installation routine.

System requirements
===================
TYPO3 requires a web server with PHP installation and a database. While TYPO3
can be configured to run on many web servers with different databases, this
document assumes that Apache and MySQL will be used. This document does not
cover using TYPO3 with other databases or web servers.

The following configuration is the minimum required:
- a web server capable of running PHP
- PHP 5.2.0 or newer with the following extensions:
- filter
- GD2
- JSON
- mysql
- pcre
- session
- SPL
- standard
- xml
- memory_limit set at least to 64M in php.ini
- MySQL 4.1 or newer
- 200 MB of disk space
- AllowOverride in Apache configuration at least to allow "Indexes"

The following configuration is recommended:
- Apache 2.x
- mod_expires and mod_rewrite enabled in Apache configuration
- PHP 5.2.0 or newer with the following extensions:
- cURL
- filter
- GD2
- JSON
- mbstring
- mysql
- pcre
- session
- SPL
- standard
- xml
- memory_limit set to 128M or more in php.ini
- MySQL 4.1 or newer
- GraphicsMagick
- 200 MB or more of disk space
- AllowOverride in Apache configuration at least to allow "Indexes"

Obtaining TYPO3
===============
To obtain TYPO3, navigate to the following location:
http://typo3.org/download/packages/

TYPO3 consists from two packages: source and dummy. Source package contains
files that every TYPO3 web site shares. Dummy package contains files unique to
each TYPO3 installation.

To install TYPO3, both packages should be downloaded.

Installation: simple (not recommended!)
=======================================
This procedure is not recommended because it makes upgrades harder. However it
can be the only option if hosting company does not provide SSH access to the web
space.

To install TYPO3, unpack the source package locally on your computer. Unpacking
will produce a directory named like typo3_src-x.y.z, where x, y and z correspond
to the TYPO3 version. For example, TYPO3 4.3.0 source package will create a
directory named typo3_src-4.3.0. Next unpack dummy package. This will create a
dummy-x.y.z directory. Create another directory and copy all files from within
typo3_src-x.y.z and dummy-x.y.z into the newly created directory.

Use FTP or SFTP program or any other available way to upload all files to your
web server.

Change permissions to files. The following directories and files should be
read-only for the web server:
t3lib/
typo3/
index.php

All other directories should be writable for the web server. If you are in
doubt, contact your hosting company and ask them to assist in adjusting
permissions.

Installation: recommended
=========================
To install TYPO3, unpack the source package outside of your web site root
directory. The location should be accessible to the web server. Unpacking will
produce a directory named like typo3_src-x.y.z, where x, y and z correspond to
the TYPO3 version. For example, TYPO3 4.3.0 source package will create a
directory named typo3_src-4.3.0.

Unpack dummy package in the temporary location on the disk. This will create a
dummy-x.y.z directory. Move all files from the dummy-x.y.x directory to the web
site root directory.

Linux, Unix and Mac OS X users should use tar.gz packages and unpack them using:
tar xzf source-x.y.z
tar xzf dummy-x.y.z

Windows users can use Windows built-in unpacker on unpack ZIP versions of
packages.

On Linux, Unix or Mac OS X systems create a symbolic link named typo3_src
pointing to the source package:
ln -s /var/www/typo3_src-4.3.0 /var/www/example.com/typo3_src
Windows users can use use "junction" program by Marc Russinovich to create
links. The program can be obtained at:
http://technet.microsoft.com/en-us/sysinternals/bb896768.aspx

Next create links for typo3/ and t3lib/ directories:
cd /var/www/example.com
ln -s typo3_src/t3lib
ln -s typo3_src/typo3

Linux, Unix and Mac OS X users also create a symbolic link to index.php
ln -s typo3_src/index.php

Windows user must copy index.php from the source directory to the web site root
directory because Windows does not support links for files.

Change permissions and ownership of the directories. This usually requires
"sudo" command. If "sudo" is not available, ask your hosting company to change
permissions. Assuming that web server user is in the group named "apache",
execute the following commands in the web site root directory:
sudo chgrp -R apache fileadmin typo3temp typo3conf uploads
sudo chmod g+rwX,o-w fileadmin typo3temp typo3conf uploads

Setting up
==========
To set up TYPO3, navigate to your web site. TYPO3 installer will run in the
1-2-3 mode to easily guide you through the installation.

Troubleshooting
===============
For troubleshooting read the FAQ below. If your problem is not listed,
feel free to ask questions in the TYPO3 mailing lists.

FAQ
===
Q: I get "500 Server error" when I navigate to TYPO3 web site immediately after
installation.
A: Make sure that AllowOverride allows "Indexes" in Apache configuration. If you
cannot ensure this, rename .htaccess files to _.htaccess. TYPO3 will run
but considerably slower. Here is the list of the files to rename:
typo3/contrib/.htaccess
typo3/gfx/.htaccess
typo3/mod/user/ws/.htaccess
typo3/sysext/.htaccess
typo3/sysext/t3skin/stylesheets/.htaccess
If error does not disappear, web server error logs should help. For Apache
error log is usually localed in /var/log/apache2 or /var/log/httpd. Check
with you hosting provider if in doubt where logs are.

Q: I went through set up process and create admin user. But I cannot login.
A: If you use MySQl 5.x or newer, try setting it to "compatible" mode. Open
Install tool under http://example.com/typo3/install/ (where example.com is
your web site domain), navigate to "All configuration" Find "setDBinit" there
and add this line to the top of the input field:
SET SESSION sql_mode='MYSQL40'


SVN document information: $Id: $
    (1-1/1)