Difference between revisions of "Configuration file"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
VisualWikitext
m
m
Line 1: Line 1:
 
{{TemplateDocDevEn}}
 
{{TemplateDocDevEn}}
−
{{ToTranslate}}
+
The Dolibarr configuration file is '''conf/conf.php'''. It is created by the automatic install process.
−
 
+
Content of this file is :
−
Le fichier de configuration de Dolibarr est '''conf/conf.php'''. Il est écrit par la procédure d'installation automatisée.
 
−
Le contenu du fichier standard est :
 
  
 
     $dolibarr_main_document_root="/home/www/dolibarr/htdocs";
 
     $dolibarr_main_document_root="/home/www/dolibarr/htdocs";
−
     $dolibarr_main_url_root="http://mondomaine.com/dolibarr";
+
     $dolibarr_main_url_root="http://mydomain.com/dolibarr";
 
     $dolibarr_main_db_type="mysql";
 
     $dolibarr_main_db_type="mysql";
 
     $dolibarr_main_db_host="localhost";
 
     $dolibarr_main_db_host="localhost";
Line 14: Line 12:
 
     $dolibarr_main_db_pass="";
 
     $dolibarr_main_db_pass="";
  
−
Dolibarr fournit un fichier conf modèle nommé conf/conf.php.example où chaque paramètre est commenté.
+
Dolibarr provide a model of file named conf/conf.php.example where each parameter is commented.
  
−
Ce fichier ne doit pas jamais être ni modifié, ni lu directement, par aucune fonctionnalité de Dolibarr.
+
This file must never be modified, never read directly by any Dolibarr feature.
  
−
Il est créé par la procédure d'installation ou de mise a jour de Dolibarr (install/index.php) qui est la seule habilitée à effectuer des actions sur ce fichier.
+
It is created by the install or update process of Dolibarr (install/index.php) that is the only process allowed to make actions on this file.
  
−
Le contenu de ce fichier est accessible au développement à travers de constantes ou de l'objet '''$conf''' créé par le script '''master.inc.php''' qui est appelé par tout programme PHP (scripts ou pages).
+
Content of file must be used by developers by using predefined constants or the object '''$conf''' created by the script '''master.inc.php''' that must be called at beginning of every PHP program (scripts or pages).
  
−
Ainsi:
+
So:
−
# $dolibarr_main_document_root est connu dans le code grâce à la constante: DOL_DOCUMENT_ROOT
+
# $dolibarr_main_document_root is known in code in constant: DOL_DOCUMENT_ROOT
−
# $dolibarr_main_url_root est connu dans le code grâce à la constante: DOL_URL_ROOT
+
# $dolibarr_main_url_root is known in code in constant: DOL_URL_ROOT
−
# $dolibarr_main_db_type est accessible par $conf->db->type
+
# $dolibarr_main_db_type is known in code on variable $conf->db->type
−
# $dolibarr_main_db_host est accessible par $conf->db->host
+
# $dolibarr_main_db_host is known in code on variable $conf->db->host
−
# $dolibarr_main_db_name est accessible par $conf->db->name
+
# $dolibarr_main_db_name is known in code on variable $conf->db->name
−
# $dolibarr_main_db_user est accessible par $conf->db->login
+
# $dolibarr_main_db_user is known in code on variable $conf->db->login
−
# $dolibarr_main_db_pass n'est pas accessible. Il est lu par le script '''master.inc.php''' (appelé par tout fichier PHP) qui crée un connexion db puis efface de sa mémoire le mot de passe.
+
# $dolibarr_main_db_pass is not known by code. It is read by script '''master.inc.php''' (called by every PHP program) that created on object connexion $db then variable $dolibarr_main_db_pass is erased.
  
−
Normalement, vos développements ne devraient avoir besoin que des constantes DOL_DOCUMENT_ROOT (qui indique le chemin physique du répertoire de stockage de fichiers temporaires ou à conserver) et DOL_URL_ROOT (qui indique le chemin URL vers le répertoire racine de Dolibarr).
+
You development should only need to use constants DOL_DOCUMENT_ROOT (that indicate physical path of directory where permanent or temporary files are stored) and DOL_URL_ROOT (that indicate relative URL that is Dolibarr root).
−
D'autres informations et objets sont disponibles après insertion de l'include de '''master.inc.php''' dans son code.  
+
More information and objects are available after including a call to '''master.inc.php''' in your PHP pages.  
  
−
Voir les tutoriaux sur le [[Developpement_module|développements de modules]] Dolibarr pour plus d'information.
+
See tutorial on page [[Module development|Module development]] for more information.

Revision as of 11:39, 27 July 2009

Return to developer
documentation index

File Doc dev.png

The Dolibarr configuration file is conf/conf.php. It is created by the automatic install process. Content of this file is : 

    $dolibarr_main_document_root="/home/www/dolibarr/htdocs";
    $dolibarr_main_url_root="http://mydomain.com/dolibarr";
    $dolibarr_main_db_type="mysql";
    $dolibarr_main_db_host="localhost";
    $dolibarr_main_db_name="dolibarr";
    $dolibarr_main_db_user="dolibarr";
    $dolibarr_main_db_port="123456";
    $dolibarr_main_db_pass="";

Dolibarr provide a model of file named conf/conf.php.example where each parameter is commented.

This file must never be modified, never read directly by any Dolibarr feature.

It is created by the install or update process of Dolibarr (install/index.php) that is the only process allowed to make actions on this file.

Content of file must be used by developers by using predefined constants or the object $conf created by the script master.inc.php that must be called at beginning of every PHP program (scripts or pages).

So:

  1. $dolibarr_main_document_root is known in code in constant: DOL_DOCUMENT_ROOT
  2. $dolibarr_main_url_root is known in code in constant: DOL_URL_ROOT
  3. $dolibarr_main_db_type is known in code on variable $conf->db->type
  4. $dolibarr_main_db_host is known in code on variable $conf->db->host
  5. $dolibarr_main_db_name is known in code on variable $conf->db->name
  6. $dolibarr_main_db_user is known in code on variable $conf->db->login
  7. $dolibarr_main_db_pass is not known by code. It is read by script master.inc.php (called by every PHP program) that created on object connexion $db then variable $dolibarr_main_db_pass is erased.

You development should only need to use constants DOL_DOCUMENT_ROOT (that indicate physical path of directory where permanent or temporary files are stored) and DOL_URL_ROOT (that indicate relative URL that is Dolibarr root). More information and objects are available after including a call to master.inc.php in your PHP pages.

See tutorial on page Module development for more information.

Retrieved from "https://wiki.dolibarr.org/index.php?title=Configuration_file&oldid=13253"