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