1 .. -*- coding: utf-8 -*- |
|
2 |
|
3 .. _cubicweb-ctl: |
|
4 |
|
5 L'outil `cubicweb-ctl` |
|
6 ====================== |
|
7 `cubicweb-ctl` est le couteau suisse pour la gestion d'instances CubicWeb. |
|
8 La syntaxe générale est :: |
|
9 |
|
10 cubicweb-ctl <commande> [options commande] <arguments commandes> |
|
11 |
|
12 Pour voir les commandes disponibles :: |
|
13 |
|
14 cubicweb-ctl |
|
15 cubicweb-ctl --help |
|
16 |
|
17 A noter que les commandes disponibles varient en fonction des parties d'CubicWeb |
|
18 qui sont installées. |
|
19 |
|
20 Pour voir l'aide pour une commande spécifiques :: |
|
21 |
|
22 cubicweb-ctl <commande> --help |
|
23 |
|
24 Commandes pour la création d'un cube |
|
25 ------------------------------------ |
|
26 * ``newcube``, crée un nouveau cube sur le système de fichiers |
|
27 à partir du nom passé en paramètre. Cette commande crée le cube à partir |
|
28 d'une squelette d'application, incluant également les fichiers pour le |
|
29 packaging debian) |
|
30 |
|
31 Commandes pour la création d'une instance |
|
32 ----------------------------------------- |
|
33 * ``create``, crée les fichiers de configuration d'une instance |
|
34 * ``db-create``, crée la base de données système d'une instance (tables et |
|
35 extensions uniquement) |
|
36 * ``db-init``, initialise la base de données système d'une instance (schéma, |
|
37 groupes, utilisateurs, workflows...) |
|
38 |
|
39 Par défaut ces trois commandes sont enchainées. |
|
40 |
|
41 Commande pour la création d'une instance pour Google App Engine |
|
42 --------------------------------------------------------------- |
|
43 * ``newgapp``, crée les fichiers de configuration d'une instance |
|
44 |
|
45 Cette commande doit être suivie de l'exécution de commandes |
|
46 permettant l'initialisation de la base de données spécifique à |
|
47 Google App Engine, appellée ``datastore``. |
|
48 |
|
49 Pour plus de détails veuillez vous référer à `LAX <>`_ |
|
50 |
|
51 |
|
52 Commandes pour le lancement des instances |
|
53 ----------------------------------------- |
|
54 * ``start``, démarre une, plusieurs, ou toutes les instances |
|
55 * ``stop``, arrêt une, plusieurs, ou toutes les instances |
|
56 * ``restart``, redémarre une, plusieurs, ou toutes les instances |
|
57 * ``status``, donne l'état des instances |
|
58 |
|
59 Commandes pour la maintenance des instances |
|
60 ------------------------------------------- |
|
61 * ``upgrade``, lance la migration d'instance(s) existante(s) lorsqu'une nouvelle |
|
62 version d'CubicWeb ou du composant est installée |
|
63 * ``shell``, ouvre un shell de migration pour la maintenance manuelle d'une instance |
|
64 * ``db-dump``, crée un dump de la base de données système |
|
65 * ``db-restore``, restore un dump de la base de données système |
|
66 * ``db-check``, vérifie l'intégrité des données d'une instance. Si la correction |
|
67 automatique est activée, il est conseillé de faire un dump avant cette |
|
68 opération |
|
69 * ``schema-sync``, , synchronise le schéma persistent d'une instance avec le schéma |
|
70 de l'application. Il est conseillé de faire un dump avant cette opération |
|
71 |
|
72 Commandes pour la maintenance des catalogues i18n |
|
73 ------------------------------------------------- |
|
74 * ``i18ncubicweb``, regénère les catalogues de messages de la librairie CubicWeb |
|
75 * ``i18ncube``, regénère les catalogues de messages d'un composant |
|
76 * ``i18ninstance``, recompile les catalogues de messages d'une instance. Cela est |
|
77 effectué automatiquement lors d'une upgrade |
|
78 |
|
79 Cf :ref:`Internationalisation`. |
|
80 |
|
81 Autres commandes |
|
82 ---------------- |
|
83 * ``list``, donne la liste des configurations, des composants et des instances |
|
84 disponibles |
|
85 * ``delete``, supprime une instance (fichiers de configuration et base de données) |
|
86 |
|
87 |
|
88 |
|
89 Exemples |
|
90 -------- |
|
91 |
|
92 Creation d'une instance a partir de cube existant |
|
93 ````````````````````````````````````````````````` |
|
94 |
|
95 Afin de creer une instance a partir d'un cube existant, executez la commande |
|
96 suivant :: |
|
97 |
|
98 cubicweb-ctl create <nom_cube> <nom_instance> |
|
99 |
|
100 Cette commande va creer les fichiers de configuration d'une instance dans |
|
101 ``~/etc/cubicweb.d/<nom_instance>``. |
|
102 L'outil ``cubicweb-ctl`` va vous autoriser a executer au sein de ``create`` |
|
103 les commandes ``db-create`` et ``db-init`` afin de completer la creation de |
|
104 votre instance en une seule commande. |
|
105 |
|
106 Si vous decidez de ne pas le faire lorsque ``cubicweb-ctl create`` vous le |
|
107 propose, alors n'oubliez pas de lancer ces commandes (``cubicweb-ctl db-create``, |
|
108 ``cubicweb-ctl db-init`` ) par la suite, sinon |
|
109 votre installation ne sera pas complete. |
|
110 |
|
111 |
|
112 Creation d'une instance a partir d'une nouveau cube |
|
113 ``````````````````````````````````````````````````` |
|
114 |
|
115 Creez avant tout votre nouveau cube :: |
|
116 |
|
117 cubicweb-ctl newcube <nom_cube> |
|
118 |
|
119 Cette commande va creer un nouveau cube dans ``/path/to/forest/cubicweb/cubes/<nom_cube>``. |
|
120 |
|
121 |
|