From a5acd5d6cacc388450bd91573436722fabc40a8f Mon Sep 17 00:00:00 2001 From: Loic d'Anterroches Date: Thu, 13 Nov 2008 08:52:56 +0100 Subject: [PATCH] Improved the documentation based on a LinuxFr comment. --- INSTALL.mdtext | 38 ++++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/INSTALL.mdtext b/INSTALL.mdtext index 50231bb..4cc2a40 100644 --- a/INSTALL.mdtext +++ b/INSTALL.mdtext @@ -1,12 +1,38 @@ # Quick installation instruction +The installation of InDefero is composed of 2 parts, first the +installation of the [Pluf framework](http://www.pluf.org) and second, +the installation of InDefero by itself. + +## Installation of Pluf + * Checkout the trunk of [Pluf](http://www.pluf.org). -* Install the `Mail` and `Mail_mime` classes from [PEAR](http://pear.php.net). +* Install the `Mail` and `Mail_mime` classes from [PEAR](http://pear.php.net). You must use the `--alldeps` flag when installing these modules: + + $ sudo pear install --alldeps Mail + $ sudo pear install --alldeps Mail_mime + +The Pluf installation folder is the folder containing the file `Pluf.php`. + +## Installation of InDefero + +The installation is composed of the following steps: + +* Get the InDefero archive. +* Configure it correctly. +* Installation the database with the `migrate.php` script. +* Bootstrap the application with a `bootstrap.php` script. + +Here is the step-by-step installation procedure: + +* Extract the InDefero archive somewhere. +* The InDefero installation folder is the folder containing this file INSTALL.mdtext. * Make a copy of `src/IDF/conf/idf.php-dist` as `src/IDF/conf/idf.php`. * Update the idf.php file to match your system. -* Run `php /path/to/pluf/src/migrate.php --conf=IDF/conf/idf.php -a -i -d -u` to test the installation of the tables. -* Run `php /path/to/pluf/src/migrate.php --conf=IDF/conf/idf.php -a -i -d` to really install the tables. -* Create a bootsrap file to create the first project and admin user for example `www/bootstrap.php`: +* Open a terminal/shell and go into the InDefero installation folder. +* Run `php /path/to/pluf/src/migrate.php --conf=src/IDF/conf/idf.php -a -i -d -u` to test the installation of the tables. +* Run `php /path/to/pluf/src/migrate.php --conf=src/IDF/conf/idf.php -a -i -d` to really install the tables. +* Create a bootstrap file to create the first project and admin user for example `www/bootstrap.php`. Do not forget to update the second line with your path to Pluf: -* Run `php bootstrap.php`. -* Remove the `bootstrp.php` file. +* Run `php www/bootstrap.php`. +* Remove the `www/bootstrap.php` file. Now you can login with this user into the interface.