goa/doc/devmanual_fr/chap_configuration_instance.txt
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Thu, 21 Jan 2010 11:08:41 +0100 (2010-01-21)
changeset 4314 e12ee4a009bc
parent 1398 5fe84a5f7035
permissions -rw-r--r--
merge
Configuration d'une instance
============================

� la cr�ation d'une instance, un fichier de configuration est g�n�r� dans ::

   $(CW_REGISTRY)/<instance>/<nom configuration>.conf

par exemple ::

   /etc/cubicweb.d/jpl/all-in-one.conf

C'est un simple fichier texte au format INI. Dans la description suivante,
chaque nom d'option est pr�fix� de sa section et suivi de sa valeur par d�faut
le cas �ch�ant, e.g. "`<section>.<option>` [valeur]".


Configuration du serveur web
----------------------------
:`web.auth-mode` [cookie]: 
   mode d'authentification, cookie ou http
:`web.realm`: 
   realm de l'application en mode d'authentification http
:`web.http-session-time` [0]:
   d�lai d'inactivit� d'une session HTTP avant sa fermeture automatique. Dur�e
   en secondes, 0 signifiant pas d'expiration (ou plus exactement lors de la
   fermeture du navigateur du client)

:`main.anonymous-user`, `main.anonymous-password`:
   login et mot de passe � utiliser pour se connecter au serveur RQL lors des
   connexions HTTP anonymes. Il faut que le compte CWUser associ� existe.

:`main.base-url`:
   url de base du site, � utiliser pour g�n�rer les urls des pages web

Configuration https
```````````````````
Il est possible de rendre un site accessible en http pour les connections 
anonymes et en https pour les utilisateurs authentifi�. Il faut pour cela
utiliser apache (par ex.) pour la redirection et la variable `main.https-url` du
fichier de configuration.

:Exemple:

  pour une redirection apache d'un site accessible via `http://localhost/demo`
  et `https://localhost/demo` et qui tourne en r�alit� sur le port 8080, il 
  faut avoir pour la version http : ::

    RewriteCond %{REQUEST_URI} ^/demo
    RewriteRule ^/demo$ /demo/
    RewriteRule ^/demo/(.*) http://127.0.0.1:8080/$1 [L,P]
  
  et pour la version https : ::

    RewriteCond %{REQUEST_URI} ^/demo
    RewriteRule ^/demo$ /demo/
    RewriteRule ^/demo/(.*) http://127.0.0.1:8080/https/$1 [L,P]


  et on aura dans le fichier all-in-one.conf de l'instance : ::

    base-url = http://localhost/demo
    https-url = `https://localhost/demo`

Configuration de l'interface web
--------------------------------
:`web.embed-allowed`:
   expression r�guli�re correspondant aux sites pouvant �tre "incorpor�" dans
   le site (controleur 'embed')
:`web.submit-url`:
   url � laquelle les bugs rencontr�s dans l'application peuvent �tre post�


Configuration du serveur RQL
----------------------------
:`main.host`:
   nom de l'h�te s'il ne peut �tre d�tecter correctement
:`main.pid-file`:
   fichier o� sera �crit le pid du serveur
:`main.uid`:
   compte utilisateur � utiliser pour le lancement du serveur quand il est
   lanc� en root par init
:`main.session-time [30*60]`:
   temps d'expiration d'une session RQL
:`main.query-log-file`:
   fichier dans lequel �crire toutes les requ�tes RQL �x�cut�es par le serveur


Configuration Pyro pour l'instance
-----------------------------------
Cot� serveur web :

:`pyro-client.pyro-application-id`: 
   identifiant pyro du serveur RQL (e.g. le nom de l'instance)

Cot� serveur RQL :

:`pyro-server.pyro-port`:
   num�ro de port pyro. Si aucune valeur n'est sp�cifi�e, un port est attribu�
   automatiquement.

Cot� serveur RQL et serveur web :

:`pyro-name-server.pyro-ns-host`:
   nom de l'h�te h�bergeant le serveur de nom pyro. Si aucune valeur n'est
   sp�cifi�, il est localis� par une requ�te de broadcast
:`pyro-name-server.pyro-ns-group` [cubicweb]:
   groupe pyro sous lequel enregistrer l'application


Configuration courriel
----------------------
Cot� serveur RQL et serveur web :

:`email.mangle-emails [no]`:
   indique si les adresses email doivent �tre affich�es telle quelle ou
   transform�e

Cot� serveur RQL :

:`email.smtp-host [mail]`:
   nom de l'h�te h�bergeant le serveur SMTP � utiliser pour le courriel sortant
:`email.smtp-port [25]`:
   port du serveur SMTP � utiliser pour le courriel sortant
:`email.sender-name`:
   nom � utiliser pour les courriels sortant de l'application
:`email.sender-addr`:
   adresse � utiliser pour les courriels sortant de l'application
:`email.default-dest-addrs`:
   adresses de destination par d�faut, si utilis� par la configuration de la 
   diffusion du mod�le (s�par�es par des virgules)
:`email.supervising-addrs`:
   addresses de destination des courriels de supervision (s�par�es par des 
   virgules)


Configuration journalisation
----------------------------
:`main.log-threshold`:
   niveau de filtrage des messages (DEBUG, INFO, WARNING, ERROR)
:`main.log-file`:
   fichier dans lequel �crire les messages


Configuration Eproperties
-------------------------
D'autres param�tres de configuration sont sous la forme d'entit�s `CWProperty`
dans la base de donn�es. Il faut donc les �diter via l'interface web ou par des
requ�tes rql.

:`ui.encoding`:
   encodage de caract�res � utiliser pour l'interface web
:`navigation.short-line-size`: # XXX should be in ui
   nombre de caract�res maximum pour les affichages "courts"
:`navigation.page-size`:
   nombre d'entit�s maximum � afficher par page de r�sultat
:`navigation.related-limit`:
   nombre d'entit�s li�es maximum � afficher sur la vue primaire d'une entit�
:`navigation.combobox-limit`:
   nombre d'entit�s non li�es maximum � afficher sur les listes d�roulantes de
   la vue d'�dition d'une entit�