Dolibarr ERP CRM Wiki - User contributions [en]

Configuration file

2010-08-22T03:24:24Z

Eldy3: /* Usage in coding */

[[Category:Admin]]
{{TemplateDocDevEn}}
The Dolibarr configuration file is '''conf/conf.php'''. It is created by the automatic install process.

= Content =
Content of this file is :
<source lang="php">
$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_port="3306";
$dolibarr_main_db_name="dolibarr";
$dolibarr_main_db_user="dolibarr";
$dolibarr_main_db_pass="";
</source>

''' Other options''':
<source lang="php">
$dolibarr_main_demo="demologin,demopass"
</source>
-> Disable some features to limit software when used as a demo software. This is to avoid that everybody make everything with a demo instance of Dolibarr.

<source lang="php">
$dolibarr_main_prod="1"
</source>
-> When this option is added in conf file, no information will be reported by Dolibarr when an internal error occurs. This is to use in a production environment to hide any information to hackers.

<source lang="php">
$dolibarr_main_authentication="dolibarr"
</source>
-> Allows to change the way the password is checked when a user ty to login to Dolibarr:
* Value "dolibarr" means check is done with the password stored in database.
* "ldap" ask to use a LDAP server (in this case, you must also define other LDAP parameters (See file conf.php.example)
* "http" use basic http protocol (need to configure your web server to set dolibarr inside a basic authentication area)

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

= Read/Write file =
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.

= Usage in coding =
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:
* $dolibarr_main_document_root is known in code in constant: DOL_DOCUMENT_ROOT
* $dolibarr_main_url_root is known in code in constant: DOL_URL_ROOT
* $dolibarr_main_db_type is known in code on variable $conf->db->type
* $dolibarr_main_db_host is known in code on variable $conf->db->host
* $dolibarr_main_db_port is known in code on variable $conf->db->port
* $dolibarr_main_db_name is known in code on variable $conf->db->name
* $dolibarr_main_db_user is known in code on variable $conf->db->login
* $dolibarr_main_db_pass is not known by code. It is read by script '''master.inc.php''' (to be called by every PHP pages) 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 initialized objects are available after including a call to '''main.inc.php''' in your PHP pages.

See tutorial on page [[Module development|Module development]] or [[Script development]] for more information.

Configuration file

2010-08-22T03:23:34Z

Eldy3:

[[Category:Admin]]
{{TemplateDocDevEn}}
The Dolibarr configuration file is '''conf/conf.php'''. It is created by the automatic install process.

= Content =
Content of this file is :
<source lang="php">
$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_port="3306";
$dolibarr_main_db_name="dolibarr";
$dolibarr_main_db_user="dolibarr";
$dolibarr_main_db_pass="";
</source>

''' Other options''':
<source lang="php">
$dolibarr_main_demo="demologin,demopass"
</source>
-> Disable some features to limit software when used as a demo software. This is to avoid that everybody make everything with a demo instance of Dolibarr.

<source lang="php">
$dolibarr_main_prod="1"
</source>
-> When this option is added in conf file, no information will be reported by Dolibarr when an internal error occurs. This is to use in a production environment to hide any information to hackers.

<source lang="php">
$dolibarr_main_authentication="dolibarr"
</source>
-> Allows to change the way the password is checked when a user ty to login to Dolibarr:
* Value "dolibarr" means check is done with the password stored in database.
* "ldap" ask to use a LDAP server (in this case, you must also define other LDAP parameters (See file conf.php.example)
* "http" use basic http protocol (need to configure your web server to set dolibarr inside a basic authentication area)

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

= Read/Write file =
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.

= Usage in coding =
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:
* $dolibarr_main_document_root is known in code in constant: DOL_DOCUMENT_ROOT
* $dolibarr_main_url_root is known in code in constant: DOL_URL_ROOT
* $dolibarr_main_db_type is known in code on variable $conf->db->type
* $dolibarr_main_db_host is known in code on variable $conf->db->host
* $dolibarr_main_db_port is known in code on variable $conf->db->port
* $dolibarr_main_db_name is known in code on variable $conf->db->name
* $dolibarr_main_db_user is known in code on variable $conf->db->login
* $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 initialized objects are available after including a call to '''main.inc.php''' in your PHP pages.

See tutorial on page [[Module development|Module development]] or [[Script development]] for more information.

Fichero de configuración

2010-08-22T03:23:23Z

Eldy3:

[[Category:Admin]]
{{TemplateDocDesarrollo}}

El fichero de configuración de Dolibarr es '''conf/conf.php'''. Es escrito por el proceso de instalación automático.

= Contenido =
El contenido del fichero standard es :

<source lang="php">
$dolibarr_main_document_root="/home/www/dolibarr/htdocs";
$dolibarr_main_url_root="http://midominio.com/dolibarr";
$dolibarr_main_db_type="mysql";
$dolibarr_main_db_host="localhost";
$dolibarr_main_db_port="3306";
$dolibarr_main_db_name="dolibarr";
$dolibarr_main_db_user="dolibarr";
$dolibarr_main_db_pass="";
</source>

'''Otras configuraciones :'''
<source lang="php">
$dolibarr_main_demo="logindemo,passdemo"
</source>
-> Desactiva algunas funciones para hacer que la aplicación quede fijada en ciertos niveles. Esto es necesario si se accede a Dolibarr como sitio de demostración para los usuarios a quienes les gusta un poco trastear.
<source lang="php">
$dolibarr_main_prod="1"
</source>
-> Cuando se define este opción, los mensajes de error internos no son mostrados en la pantalla. Esta opción se ha concebido para los entornos de producción, con el fin de no divulgar información a malintencionados.

<source lang="php">
$dolibarr_main_authentication="dolibarr"
</source>
Permite cambiar la forma de control de la contraseña:
* El valor "dolibarr" se basa en la contraseña sobre la base de datos.
* "ldap" se base sobre LDAP (en este caso se deberán indicar otros parámetros de LDAP (ver archivo conf.php.example)
* "http" utiliza el protocolo de autenticación HTTP Basic (es necesario configurar su servidor web para disponer de Dolibarr dentro de una sesión de autentificación HTTP Basic)

Dolibarr proporciona una archivo conf como plantilla llamado '''conf/conf.php.example''' donde se comenta cada parámetro.

= Modificación =
Este archivo nunca debe ser modificado, ni directamente, ni por cualquier funcionalidad de Dolibarr.

Es creado por el proceso de instalación o actualización de Dolibarr (install/index.php), quien es el único autorizado a realizar acciones sobre este fichero.

= Desarrollo =
El contenido de este fichero es accesible en desarrollo a través de constantes ó del objeto '''$conf''' creado por el script '''master.inc.php''' que es llamado por todos los fuentes PHP (scripts ó págines).

* $dolibarr_main_document_root se conoce en el código mediante la constante: DOL_DOCUMENT_ROOT
* $dolibarr_main_url_root se conoce en el código mediante la constante:: DOL_URL_ROOT
* $dolibarr_main_db_type es accesible por $conf->db->type
* $dolibarr_main_db_host es accesible por $conf->db->host
* $dolibarr_main_db_port es accesible por $conf->db->port
* $dolibarr_main_db_name es accesible por $conf->db->name
* $dolibarr_main_db_user es accesible por $conf->db->login
* $dolibarr_main_db_pass no es accesible. Es leída por el script '''master.inc.php''' (llamado por todo fichero PHP) que crea una conexión '''$db''' tras borrar de su memoria la contraseña.

Normalmente, en los desarrollos no debería hacer falta nada más que las constantes DOL_DOCUMENT_ROOT (que indica la ruta física de la carpeta de almacenaje de ficheros temporales o a conservar) y DOL_URL_ROOT (que indica la ruta URL hacia la carpeta raíz de Dolibarr).

Otras informaciones y objetos se encuentran disponibles tras la inserción del include de '''main.inc.php''' en el código.

Ver los tutoriales sobre el [[Desarrollo de un módulo|desarrollo de módulos]] y [[Desarrollo de scripts|desarrollo de scripts]] Dolibarr para más información.

Fichier de configuration

2010-08-22T03:23:05Z

Eldy3:

[[Category:Admin]]
{{TemplateDocDev}}

Le fichier de configuration de Dolibarr est '''conf/conf.php'''. Il est écrit par la procédure d'installation automatisée.

= Contenu =
Le contenu du fichier standard est :
<source lang="php">
$dolibarr_main_document_root="/home/www/dolibarr/htdocs";
$dolibarr_main_url_root="http://mondomaine.com/dolibarr";
$dolibarr_main_db_type="mysql";
$dolibarr_main_db_host="localhost";
$dolibarr_main_db_port="3306";
$dolibarr_main_db_name="dolibarr";
$dolibarr_main_db_user="dolibarr";
$dolibarr_main_db_pass="";
</source>

'''Autres options :'''
<source lang="php">
$dolibarr_main_demo="demologin,demopass"
</source>
-> Désactive certaines fonctions pour rendre l'application figée à certains niveaux. Ceci est requis si Dolibarr est en accès comme site de démo à des utilisateurs qui aiment un peu trop faire n'importe quoi.

<source lang="php">
$dolibarr_main_prod="1"
</source>
-> Quand cette option est définie, les messages d'erreurs internes à Dolibarr ne sont plus remontée à l'écran. Cette option est conçue pour les environnements de production afin de ne pas divulguer d'informations aux hackers.

<source lang="php">
$dolibarr_main_authentication="dolibarr"
</source>
-> Permet de changer la manière dont le mot de passe est controlé:
* La valeur "dolibarr" s'appuie sur le mot de passe en base de donnée.
* "ldap" permet de se baser sur un annuaire LDAP (dans ce cas il faut renseigner les autres parametres LDAP (vor ficiher conf.php.example).
* "http" utilise l'authentification du protocol HTTP Basic (il est nécesssaire de configurer votre serveur web pour avoir Dolibarr dans une session d'authentification HTTP Basic).

Dolibarr fournit un fichier conf modèle nommé '''conf/conf.php.example''' où chaque paramètre est commenté.

= Lecture/Ecriture du fichier =
Ce fichier ne doit pas jamais être ni lu directement, ni modifié par aucune fonctionnalité de Dolibarr.

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.

= Utilisation dans le code =
Le contenu de ce fichier est accessible au développement au 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).

Ainsi:
* $dolibarr_main_document_root est connu dans le code grâce à la constante: DOL_DOCUMENT_ROOT (mais aussi dans le tableau $conf->file->dol_document_root[]
* $dolibarr_main_url_root est connu dans le code grâce à la constante: DOL_URL_ROOT
* $dolibarr_main_db_type est accessible par $conf->db->type
* $dolibarr_main_db_host est accessible par $conf->db->host
* $dolibarr_main_db_port est accessible par $conf->db->port
* $dolibarr_main_db_name est accessible par $conf->db->name
* $dolibarr_main_db_user est accessible par $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.

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).

D'autres informations et variables déjà initialisées sont disponibles après insertion de l'include de '''main.inc.php''' dans son code.

Voir les tutoriaux sur le [[Developpement_module|Développements de modules]] ou [[Développement de scripts]] pour plus d'information.