diff options
| -rw-r--r-- | INSTALL.txt | 152 |
1 files changed, 98 insertions, 54 deletions
diff --git a/INSTALL.txt b/INSTALL.txt index 447defbee..de5617fd4 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,60 +1,104 @@ -Elgg 1.0 installation
+ELGG 1.0 INSTALLATION INSTRUCTIONS
-This is a placeholder file, and will be rewritten before the official
-launch. However, here are some basic instructions. Commercial
-support is available for Elgg; email info@elgg.com for more details.
+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.
-CORE REQUIREMENTS
+Due to Elgg's advanced functionality, there are some extra
+configuration requirements:
- * Apache web server with the following modules:
+ * The Apache web server needs to be installed with the following
+ modules:
o mod_rewrite
- o PHP (see below)
- * MySQL 5+
- * PHP 5.2+ as an Apache mod (not in CGI mode or safe mode)
- with the following libraries:
- o GD
- o JSON
-
-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.
-
-INSTRUCTIONS
-
-1. Upload Elgg
-
-Upload Elgg to your site's document root. Create a folder for
-Elgg to store files, preferably underneath the document root.
-Make sure that the folder has the proper permissions, for example:
-
-chmod 777 /home/mysite/data
-Create a database
-
-Create a database for Elgg to store its data. Because of Elgg's
-ability to host multiple sites you will only have to do this once.
-
-2. Setup
-
-Once you've completed the previous step, point your browser to your
-site. You'll be greeted by the Elgg installer. Once it's set up a
-few essential files, the installer will ask for the database details
-(database username, password, database name and table prefix) if not
-already set up in the previous step, and some basic details for
-setting up your first (primary) Elgg site, where Elgg will already
-have guessed some initial values:
-
- * The name of your site
- * The site URL
- * The full path to your site root on your disk
- * The full path to the directory where uploaded files will be
- stored (the data folder you created earlier)
- * The default language code for your site
- * The type of default view (leave as default for now)
-
-After this step you will be prompted to create an initial user. This
-user will be the first system administrator. This is the last step,
-and you'll be ready to start working with your new Elgg site.
-
\ No newline at end of file + o PHP
+ * MySQL 5+ is needed for data storage
+ * 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)
+
+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 mbstring (to allow emails to be sent with non-Latin
+ characters)
+ o SOAP
+ o DOM
+
+
+INSTALLING ELGG
+
+Before you begin, make sure you have read Elgg's technical
+requirements. If you discover problems after following these
+instructions, check out the troubleshooting page at
+[http://docs.elgg.org/wiki/Troubleshooting].
+
+
+1. Upload Elgg
+
+Unzip Elgg and upload it to your site's document root.
+
+
+2. Create a data folder
+
+Elgg needs a special folder to store uploaded files, including
+profile icons and photos. You will need to create this for it.
+
+We recommend that this folder is called data, and is stored outside
+of your document root. For example, if Elgg is installed in
+/home/elgg/html/, you might create it in /home/elgg/data.
+
+Once this folder has been created, you'll need to make sure Elgg 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 type something like:
+
+chmod 777 /home/elgg/data/
+
+If you use a graphical client to upload files, you can usually set
+this by right or shift-clicking on the folder and selecting
+'properties'.
+
+
+3. Create a database
+
+Using your database administration tool of choice (if you're unsure
+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. 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
+process from there.
+
+
+A note on settings and .htaccess
+
+The Elgg installer will try and create two files for you:
+
+ * engine/settings.php, which contains the database settings for
+ your installation
+ * .htaccess, which allows Elgg to generate dynamic URLs
+
+If these files can't be automatically generated, for example because
+you don't have the correct directory permissions, Elgg will tell you
+how to create them. If, for some reason, this won't work, you will
+need to:
+
+ * Copy engine/settings.example.php to engine/settings.php, open
+ it up in a text editor and fill in your database details
+ * Copy /htaccess_dist to /.htaccess
+
+
+The latest version of this document is available at:
+[http://docs.elgg.org/wiki/Installation]
\ No newline at end of file |