goa/doc/devmanual_fr/sect_erudi-ctl.txt
changeset 0 b97547f5f1fa
child 1898 39b37f90a8a4
equal deleted inserted replaced
-1:000000000000 0:b97547f5f1fa
       
     1 L'outil `cubicweb-ctl`
       
     2 -------------------
       
     3 `cubicweb-ctl` est le couteau suisse pour la gestion d'instances CubicWeb.
       
     4 La syntaxe générale est ::
       
     5 
       
     6   cubicweb-ctl <commande> [options commande] <arguments commandes>
       
     7 
       
     8 Pour voir les commandes disponibles ::
       
     9 
       
    10   cubicweb-ctl
       
    11   cubicweb-ctl --help
       
    12 
       
    13 A noter que les commandes disponibles varient en fonction des parties de CubicWeb
       
    14 qui sont installées.
       
    15 
       
    16 Pour voir l'aide pour une commande spécifiques ::
       
    17 
       
    18   cubicweb-ctl <commande> --help
       
    19 
       
    20 Commandes pour la création d'un composant
       
    21 ````````````````````````````````````````
       
    22 * ``newtemplate``, crée un nouveau composant sur le système de fichiers
       
    23   à partir du nom passé en paramètre. Cette commande crée le composant à partir
       
    24   d'une squelette d'application, incluant également les fichiers pour le
       
    25   packaging debian)
       
    26   
       
    27 Commandes pour la création d'une instance
       
    28 `````````````````````````````````````````
       
    29 * ``create``, crée les fichiers de configuration d'une instance
       
    30 * ``db-create``, crée la base de données système d'une instance (tables et
       
    31   extensions uniquement)
       
    32 * ``db-init``, initialise la base de données système d'une instance (schéma,
       
    33   groupes, utilisateurs, workflows...)
       
    34 
       
    35 Par défaut ces trois commandes sont enchainées.
       
    36 
       
    37 Commandes pour le lancement des instances
       
    38 `````````````````````````````````````````
       
    39 * ``start``, démarre une, plusieurs, ou toutes les instances
       
    40 * ``stop``, arrêt une, plusieurs, ou toutes les instances
       
    41 * ``restart``, redémarre une, plusieurs, ou toutes les instances
       
    42 * ``status``, donne l'état des instances
       
    43 
       
    44 Commandes pour la maintenance des instances
       
    45 ```````````````````````````````````````````
       
    46 * ``upgrade``, lance la migration d'instance(s) existante(s) lorsqu'une nouvelle
       
    47   version d'CubicWeb ou du composant est installée
       
    48 * ``shell``, ouvre un shell de migration pour maintenance manuelle d'une instance
       
    49 * ``db-dump``, crée un dump de la base de données système
       
    50 * ``db-restore``, restore un dump de la base de données système
       
    51 * ``db-check``, vérifie l'intégrité des données d'une instance. Si la correction
       
    52   automatique est activée, il est conseillé de faire un dump avant cette
       
    53   opération
       
    54 * ``schema-sync``, , synchronise le schéma persistent d'une instance avec le schéma
       
    55   de l'application. Il est conseillé de faire un dump avant cette opération
       
    56 
       
    57 Commandes pour la maintenance des catalogues i18n
       
    58 `````````````````````````````````````````````````
       
    59 * ``i18nlibupdate``, regénère les catalogues de messages de la librairie CubicWeb
       
    60 * ``i18nupdate``, regénère les catalogues de messages d'un composant
       
    61 * ``i18ncompile``, recompile les catalogues de messages d'une instance. Cela est
       
    62   effectué automatiquement lors d'une upgrade
       
    63 
       
    64 Cf Internationalisation_.
       
    65 
       
    66 Autres commandes
       
    67 ````````````````
       
    68 * ``list``, donne la liste des configurations, des composants et des instances
       
    69   disponibles
       
    70 * ``delete``, supprime une instance (fichiers de configuration et base de données)