Change documentation

This commit is contained in:
Michael RICOIS 2013-11-04 08:53:13 +00:00
parent c7c7372c35
commit 26fe6f06f0
2 changed files with 117 additions and 75 deletions

View File

@ -1,20 +1,112 @@
README
======
- System Requirements
- Installation
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.
SYSTEM REQUIREMENTS
===================
- Apache 2.2
- PHP 5.2.x
- PHP 5.3.x
- APC
- Chartdir library
- browscap.ini (http://tempdownloads.browserscap.com/)
- browscap.ini (http://tempdownloads.browserscap.com/, http://browscap.org/)
- wkhtmltopdf (http://code.google.com/p/wkhtmltopdf/)
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
- Static/Global Storage
data/asso
data/association
data/bilanclient
data/bodacc
data/courrier
data/giant
data/greffes
data/groupes
data/iris
data/log
data/logos
data/marques
data/nouveautes
data/wkhtml
- Temporary storage
[projet]/data/
cache
files
infogreffe
log
pages
rss
sessions
wsdl
Apache configuration
--------------------
See VHOST for example
=> Development example
<VirtualHost *:80>
ServerName extranet.sd.dev
AddDefaultCharset utf-8
DocumentRoot "WORKSPACE/extranet/public"
SetEnv APPLICATION_ENV "development"
<Directory "WORKSPACE/extranet/public/">
AllowOverride All
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 debug
ErrorLog "logs/extranet-error.log"
CustomLog "logs/extranet-access.log" common
</VirtualHost>
=> Production configuration
See VHOST file
PHP Configuration
-----------------
@ -44,39 +136,33 @@ WKHTMLTOPDF
- Set execution flag (chmod +x)
- Test
Configure your environment
==========================
WebService
----------
Partners
--------
Temporary storage - see in scripts/build/configure.php
-----------------
[projet]/
cache
files
infogreffe
log
pages
rss
sessions
wsdl
Static storage
--------------
Local configuration
===================
Voir Configuration vhost
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
Le répertoire config contient la configuration suivant les différentes machines,
à copier dans le repertoire application/configs/ et à modifier suivant votre machine
Gestion des sessions
====================
@ -102,24 +188,6 @@ Debuggage
Firebug et ChromePHP sont disponible.
Voir dans le fichier Bootstrap pour activer ou non le debuggage.
Répertoire de données (data)
============================
data/asso
data/association
data/bilanclient
data/bodacc
data/courrier
data/giant
data/greffes
data/groupes
data/iris
data/log
data/logos
data/marques
data/nouveautes
data/pdf => a remplacer par actes et bilans (Nouvelle structure)
data/wkhtml
CONFIGURATION APC
=================
apc.cache_by_default = On

View File

@ -1,33 +1,5 @@
<VirtualHost *:80>
ServerName extranet.scores-decisions.com
AddDefaultCharset utf-8
DocumentRoot "D:/www/extranet-2.0/public"
SetEnv APPLICATION_ENV "development"
<Directory "D:/www/extranet-2.0/public/">
AllowOverride All
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 debug
ErrorLog "logs/extranet20.sd.dev-error.log"
CustomLog "logs/extranet.sd.dev-access.log" common
</VirtualHost>
====================================================================================================
APACHE 2.2
==========
<VirtualHost *>
ServerName extranet.scores-decisions.com
@ -111,3 +83,5 @@
</VirtualHost>
APACHE 2.4
==========