diff options
Diffstat (limited to 'INSTALL.txt')
| -rw-r--r-- | INSTALL.txt | 51 |
1 files changed, 13 insertions, 38 deletions
diff --git a/INSTALL.txt b/INSTALL.txt index 20007fad7..f4ecbffe1 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,4 +1,4 @@ -The latest version of this document is available at: +The latest version of the installation instructions is available at: [http://docs.elgg.org/wiki/Installation] Installation Troubleshooting is available at: @@ -11,7 +11,8 @@ TECHNICAL REQUIREMENTS Elgg runs on a combination of the Apache web server, MySQL database system and the PHP interpreted scripting language. This is the most -popular web server environment in the world. +popular web server environment in the world. (Elgg can also run on +other web servers such a nginx and IIS, but requires further configuration). Due to Elgg's advanced functionality, there are some extra configuration requirements: @@ -20,25 +21,17 @@ configuration requirements: modules: o mod_rewrite o PHP - * MySQL 5+ with sql_mode in standard mode (ie not in traditional - or any other mode). - * PHP 5.2+ needs to be installed as an Apache module (not in CGI - mode or safe mode) with the following libraries: - o GD (for graphics processing, eg user icon rescaling) - o JSON (for API functionality) - o XML (not installed/compiled by default on all systems) - o Multibyte String support (for internationalisation) + * MySQL 5+. + * PHP 5.2+ needs to be installed as an Apache module + with the following libraries: + o GD (for graphics processing such as avatar cropping) + o Multibyte String support (for internationalization) It is recommended that you increase the memory available to PHP threads beyond the standard 8 or 12M, and increase the maximum uploaded filesize (which defaults to 2M). In both cases, this can be found in your php.ini. - * The following PHP libraries are also recommended for some - plugins and extra functionality: - o SOAP - o DOM - INSTALLING ELGG @@ -66,7 +59,7 @@ Once this folder has been created, you'll need to make sure that your web server has permission to write to it. This shouldn't be a problem on Windows-based servers, but if your server runs Linux or a UNIX variant, you'll need to figure out what user Apache runs under. For Debian-based -distros, it is usually www-data and for RedHat, it is often apache. If +distros, it is usually www-data and for RedHat, it is often apache. If you cannot figure out what the ownership and permissions should be, you can set the permissions for world access (though not recommended): @@ -84,25 +77,8 @@ about this, ask your system administrator), create a new database for Elgg. Make sure you know the username and password necessary to access this. -4. Install your crontab (UNIX ONLY) - -Cron is a UNIX command which allows programs to be run at set -times of the day. - -If you want to take advantage of some of the maintenance -functions such as log rotation or garbage collection, you must -install a cron tab to trigger these events. -We have provided an example crontab as /crontab.example. Edit this -with a text editor to provide the details of your site, rename it -to another filename (eg 'crontab.mine') and install it with the -following command: - - crontab crontab.mine - -Substitute your filename for 'crontab.mine'. - -5. Visit your Elgg site +4. Visit your Elgg site Once you've performed these steps, visit your Elgg site in your web browser. Elgg will take you through the rest of the installation @@ -121,11 +97,10 @@ If your web server does not have permission to create these files, you will need to either 1. Change the permissions on the directory where you are installing - Elgg and the engine directory and try again. - -2. Follow the instructions that Elgg gives you to create them. + Elgg and the engine directory and try again. Remember to change the + permissions back to the original values after installation is complete. -3. Copy engine/settings.example.php to engine/settings.php, open +2. Copy engine/settings.example.php to engine/settings.php, open it up in a text editor and fill in your database details. Then copy /htaccess_dist to /.htaccess |