doc/book/en/C030-instance-config.en.txt
changeset 127 ae611743f5c6
parent 113 1091d8d63f51
child 207 7985963869f9
equal deleted inserted replaced
126:80c65c9f7c41 127:ae611743f5c6
       
     1 .. -*- coding: utf-8 -*-
       
     2 
       
     3 Configuration d'une instance
       
     4 ============================
       
     5 
       
     6 À la création d'une instance, un fichier de configuration est généré dans ::
       
     7 
       
     8    $(CW_REGISTRY)/<instance>/<nom configuration>.conf
       
     9 
       
    10 par exemple ::
       
    11 
       
    12    /etc/cubicweb.d/jpl/all-in-one.conf
       
    13 
       
    14 C'est un simple fichier texte au format INI. Dans la description suivante,
       
    15 chaque nom d'option est préfixé de sa section et suivi de sa valeur par défaut
       
    16 le cas échéant, e.g. "`<section>.<option>` [valeur]".
       
    17 
       
    18 
       
    19 Configuration du serveur web
       
    20 ----------------------------
       
    21 :`web.auth-mode` [cookie]: 
       
    22    mode d'authentification, cookie ou http
       
    23 :`web.realm`: 
       
    24    realm de l'application en mode d'authentification http
       
    25 :`web.http-session-time` [0]:
       
    26    délai d'inactivité d'une session HTTP avant sa fermeture automatique. Durée
       
    27    en secondes, 0 signifiant pas d'expiration (ou plus exactement lors de la
       
    28    fermeture du navigateur du client)
       
    29 
       
    30 :`main.anonymous-user`, `main.anonymous-password`:
       
    31    login et mot de passe à utiliser pour se connecter au serveur RQL lors des
       
    32    connexions HTTP anonymes. Il faut que le compte EUser associé existe.
       
    33 
       
    34 :`main.base-url`:
       
    35    url de base du site, à utiliser pour générer les urls des pages web
       
    36 
       
    37 Configuration https
       
    38 ```````````````````
       
    39 Il est possible de rendre un site accessible en http pour les connections 
       
    40 anonymes et en https pour les utilisateurs authentifié. Il faut pour cela
       
    41 utiliser apache (par ex.) pour la redirection et la variable `main.https-url` du
       
    42 fichier de configuration.
       
    43 
       
    44 :Exemple:
       
    45 
       
    46   pour une redirection apache d'un site accessible via `http://localhost/demo`
       
    47   et `https://localhost/demo` et qui tourne en réalité sur le port 8080, il 
       
    48   faut avoir pour la version http : ::
       
    49 
       
    50     RewriteCond %{REQUEST_URI} ^/demo
       
    51     RewriteRule ^/demo$ /demo/
       
    52     RewriteRule ^/demo/(.*) http://127.0.0.1:8080/$1 [L,P]
       
    53   
       
    54   et pour la version https : ::
       
    55 
       
    56     RewriteCond %{REQUEST_URI} ^/demo
       
    57     RewriteRule ^/demo$ /demo/
       
    58     RewriteRule ^/demo/(.*) http://127.0.0.1:8080/https/$1 [L,P]
       
    59 
       
    60 
       
    61   et on aura dans le fichier all-in-one.conf de l'instance : ::
       
    62 
       
    63     base-url = http://localhost/demo
       
    64     https-url = `https://localhost/demo`
       
    65 
       
    66 Configuration de l'interface web
       
    67 --------------------------------
       
    68 :`web.embed-allowed`:
       
    69    expression régulière correspondant aux sites pouvant être "incorporé" dans
       
    70    le site (controleur 'embed')
       
    71 :`web.submit-url`:
       
    72    url à laquelle les bugs rencontrés dans l'application peuvent être posté
       
    73 
       
    74 
       
    75 Configuration du serveur RQL
       
    76 ----------------------------
       
    77 :`main.host`:
       
    78    nom de l'hôte s'il ne peut être détecter correctement
       
    79 :`main.pid-file`:
       
    80    fichier où sera écrit le pid du serveur
       
    81 :`main.uid`:
       
    82    compte utilisateur à utiliser pour le lancement du serveur quand il est
       
    83    lancé en root par init
       
    84 :`main.session-time [30*60]`:
       
    85    temps d'expiration d'une session RQL
       
    86 :`main.query-log-file`:
       
    87    fichier dans lequel écrire toutes les requêtes RQL éxécutées par le serveur
       
    88 
       
    89 
       
    90 Configuration Pyro pour l'instance
       
    91 -----------------------------------
       
    92 Coté serveur web :
       
    93 
       
    94 :`pyro-client.pyro-application-id`: 
       
    95    identifiant pyro du serveur RQL (e.g. le nom de l'instance)
       
    96 
       
    97 Coté serveur RQL :
       
    98 
       
    99 :`pyro-server.pyro-port`:
       
   100    numéro de port pyro. Si aucune valeur n'est spécifiée, un port est attribué
       
   101    automatiquement.
       
   102 
       
   103 Coté serveur RQL et serveur web :
       
   104 
       
   105 :`pyro-name-server.pyro-ns-host`:
       
   106    nom de l'hôte hébergeant le serveur de nom pyro. Si aucune valeur n'est
       
   107    spécifié, il est localisé par une requête de broadcast
       
   108 :`pyro-name-server.pyro-ns-group` [cubicweb]:
       
   109    groupe pyro sous lequel enregistrer l'application
       
   110 
       
   111 
       
   112 Configuration courriel
       
   113 ----------------------
       
   114 Coté serveur RQL et serveur web :
       
   115 
       
   116 :`email.mangle-emails [no]`:
       
   117    indique si les adresses email doivent être affichées telle quelle ou
       
   118    transformée
       
   119 
       
   120 Coté serveur RQL :
       
   121 
       
   122 :`email.smtp-host [mail]`:
       
   123    nom de l'hôte hébergeant le serveur SMTP à utiliser pour le courriel sortant
       
   124 :`email.smtp-port [25]`:
       
   125    port du serveur SMTP à utiliser pour le courriel sortant
       
   126 :`email.sender-name`:
       
   127    nom à utiliser pour les courriels sortant de l'application
       
   128 :`email.sender-addr`:
       
   129    adresse à utiliser pour les courriels sortant de l'application
       
   130 :`email.default-dest-addrs`:
       
   131    adresses de destination par défaut, si utilisé par la configuration de la 
       
   132    diffusion du modèle (séparées par des virgules)
       
   133 :`email.supervising-addrs`:
       
   134    addresses de destination des courriels de supervision (séparées par des 
       
   135    virgules)
       
   136 
       
   137 
       
   138 Configuration journalisation
       
   139 ----------------------------
       
   140 :`main.log-threshold`:
       
   141    niveau de filtrage des messages (DEBUG, INFO, WARNING, ERROR)
       
   142 :`main.log-file`:
       
   143    fichier dans lequel écrire les messages
       
   144 
       
   145 
       
   146 Configuration Eproperties
       
   147 -------------------------
       
   148 D'autres paramètres de configuration sont sous la forme d'entités `EProperty`
       
   149 dans la base de données. Il faut donc les éditer via l'interface web ou par des
       
   150 requêtes rql.
       
   151 
       
   152 :`ui.encoding`:
       
   153    encodage de caractères à utiliser pour l'interface web
       
   154 :`navigation.short-line-size`: # XXX should be in ui
       
   155    nombre de caractères maximum pour les affichages "courts"
       
   156 :`navigation.page-size`:
       
   157    nombre d'entités maximum à afficher par page de résultat
       
   158 :`navigation.related-limit`:
       
   159    nombre d'entités liées maximum à afficher sur la vue primaire d'une entité
       
   160 :`navigation.combobox-limit`:
       
   161    nombre d'entités non liées maximum à afficher sur les listes déroulantes de
       
   162    la vue d'édition d'une entité