[doc] Update cubicweb-ctl page about how to run an instance
authorDenis Laxalde <denis.laxalde@logilab.fr>
Wed, 27 Mar 2019 09:25:44 +0100
changeset 12522 fd64e424fba5
parent 12521 cb68c985ee01
child 12523 4d68d20427de
[doc] Update cubicweb-ctl page about how to run an instance * remove mention of start/stop/restart/status commands that do not exist anymore * briefly mention the "pyramid" and point to respective documentation page * mention that a WSGI server should be used in production
doc/book/admin/cubicweb-ctl.rst
--- a/doc/book/admin/cubicweb-ctl.rst	Wed Mar 27 09:21:18 2019 +0100
+++ b/doc/book/admin/cubicweb-ctl.rst	Wed Mar 27 09:25:44 2019 +0100
@@ -65,21 +65,19 @@
 * ``db-init``, initializes the system database of an instance
   (schema, groups, users, workflows...)
 
-Commands to control instances
------------------------------
+Run an instance
+---------------
 
-* ``start``, starts one or more or all instances
+To start an instance during development, use ::
 
-of special interest::
+   cubicweb-ctl pyramid [-D] [-l <log-level>] <instance-id>
 
-  start -D
+without ``-D``, the instance will be start in the background, as a daemon.
 
-will start in debug mode (under windows, starting without -D will not
-work; you need instead to setup your instance as a service).
+See :ref:`cubicweb-ctl_pyramid` for more details.
 
-* ``stop``, stops one or more or all instances
-* ``restart``, restarts one or more or all instances
-* ``status``, returns the status of the instance(s)
+In production, it is recommended to run CubicWeb through a WSGI server like
+uWSGI or Gunicorn. See :mod:`cubicweb.pyramid` more details.
 
 Commands to maintain instances
 ------------------------------