Complete documentation

docs/README

@@ -1,48 +1,90 @@
 README
 ======
 
+ - System Requirements
  - Installation
- - Setting up your VHOST
  - Project
  - Library
 
+Note : Project are define to be use on Linux Server, so take care about path and file name. 
+ Also some script (CLI) don't work on Windows.
 
-Installation
+
+SYSTEM REQUIREMENTS
+===================
+
+ - Apache 2.2
+ - PHP 5.3.x
+ - APC
+
+
+INSTALLATION
 ============
+
+See the file scripts/build/configure.php
+
+On server this script is automatically called with the install option.
+	configure.php --install
+
+Each servers are reference with a directory, name as the hostname, in config dir and all configure 
+file is list here
+
+
+Environment configuration
+-------------------------
+
+ - Variables
+ 	
+ Define application environment in the vhost. This mode activate special features and debugging mode.
+
+	SetEnv APPLICATION_ENV "production" => Production
+	SetEnv APPLICATION_ENV "staging" => Recette
+	SetEnv APPLICATION_ENV "development" => Developpement
  
- Give sample detail on the installation 
+
+Apache configuration
+--------------------
+
+	=> Development example
+
+	<VirtualHost *:80>
+		ServerName sdciblage.sd.dev
+		AddDefaultCharset utf-8
+		DirectoryIndex index.php
+		SetEnv APPLICATION_ENV "development"	
+		DocumentRoot "WORKSPACE/sdciblage/public"
+		<Directory "WORKSPACE/sdciblage/public/">
+			AllowOverride none
+			Order allow,deny
+			Allow from all  
+			<IfModule mod_rewrite.c>
+	            RewriteEngine On
+	            RewriteCond %{REQUEST_URI} ^/favicon.ico$ [OR]
+	            RewriteCond %{REQUEST_FILENAME} -s [OR]
+	            RewriteCond %{REQUEST_FILENAME} -l [OR]
+	            RewriteCond %{REQUEST_FILENAME} -d
+	            RewriteRule ^.*$ - [NC,L]
+				RewriteRule ^.*$ index.php [NC,L]
+			</IfModule>
+		</Directory>
+		# Possible values include: debug, info, notice, warn, error, crit, alert, emerg.
+		LogLevel notice
+		ErrorLog "logs/sdciblage-error.log"
+		CustomLog "logs/sdciblage-access.log" common
+	</VirtualHost>
 
 
-Setting Up Your VHOST
-=====================
+PHP Configuration
+-----------------
 
-The following is a sample VHOST you might want to consider for your project.
+Session
+-------
+	On sharing plateform, these parameters must be specified to the best value for all web application
 
-<VirtualHost *:80>
-	ServerName sdciblage.sd.dev
-	AddDefaultCharset utf-8
-	DirectoryIndex index.php
-	SetEnv APPLICATION_ENV "development"	
-	DocumentRoot "WORKSPACE/sdciblage/public"
-	<Directory "WORKSPACE/sdciblage/public/">
-		AllowOverride none
-		Order allow,deny
-		Allow from all  
-		<IfModule mod_rewrite.c>
-            RewriteEngine On
-            RewriteCond %{REQUEST_URI} ^/favicon.ico$ [OR]
-            RewriteCond %{REQUEST_FILENAME} -s [OR]
-            RewriteCond %{REQUEST_FILENAME} -l [OR]
-            RewriteCond %{REQUEST_FILENAME} -d
-            RewriteRule ^.*$ - [NC,L]
-			RewriteRule ^.*$ index.php [NC,L]
-		</IfModule>
-	</Directory>
-	# Possible values include: debug, info, notice, warn, error, crit, alert, emerg.
-	LogLevel notice
-	ErrorLog "logs/sdciblage-error.log"
-	CustomLog "logs/sdciblage-access.log" common
-</VirtualHost>
+    session.gc_maxlifetime = 86400
+    session.cookie_lifetime = 86400
+
+	Application must override the session.save_path, soap.wsdl_cache_dir to define it's own path.
 
 
 Project
@@ -59,8 +101,8 @@ Project
 		
 	Assets
 	------
-	- JQuery 1.10.1
-	- JQuery-UI 1.10.3	
+	- JQuery
+	- JQuery-UI	
 	
 	Development
 	-----------