[doc] how to install pyramid or twisted application server 3.26
authorLaurent Peuch <cortex@worlddomination.be>
Tue, 12 Feb 2019 14:43:45 +0100
branch3.26
changeset 12362 aa3581fc685c
parent 12354 addfdabaa35f
child 12371 923f9c9f56c5
[doc] how to install pyramid or twisted application server
doc/book/admin/setup.rst
doc/tutorials/base/blog-in-five-minutes.rst
--- a/doc/book/admin/setup.rst	Mon Oct 29 10:09:19 2018 +0100
+++ b/doc/book/admin/setup.rst	Tue Feb 12 14:43:45 2019 +0100
@@ -64,6 +64,12 @@
   apt-get update
   apt-get install cubicweb cubicweb-dev
 
+  # if you want pyramid, the recommended application server
+  apt-get install pyramid-cubicweb
+
+  # or if you want twisted (considered deprecated)
+  apt-get install cubicweb-twisted
+
 ``cubicweb`` installs the framework itself, allowing you to create new
 instances. ``cubicweb-dev`` installs the development environment
 allowing you to develop new cubes.
@@ -155,7 +161,11 @@
 
 Finally, install |cubicweb| and its dependencies, by running::
 
-  pip install cubicweb
+  # for pyramid, the recommended application server
+  pip install cubicweb[pyramid]
+
+  # or for twisted, considered deprecated (used by "cubicweb-ctl")
+  pip install cubicweb[etwist]
 
 Many other :ref:`cubes <AvailableCubes>` are available. A list is available at
 `PyPI <http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb&submit=search>`_
--- a/doc/tutorials/base/blog-in-five-minutes.rst	Mon Oct 29 10:09:19 2018 +0100
+++ b/doc/tutorials/base/blog-in-five-minutes.rst	Tue Feb 12 14:43:45 2019 +0100
@@ -8,11 +8,17 @@
 For Debian or Ubuntu users, first install the following packages
 (:ref:`DebianInstallation`)::
 
-    cubicweb, cubicweb-dev, cubicweb-blog
+    cubicweb, cubicweb-dev, cubicweb-twisted, cubicweb-blog
 
 Windows or Mac OS X users must install |cubicweb| from source (see
 :ref:`SourceInstallation` and :ref:`WindowsInstallation`).
 
+You can also install those packages using pip in a virtualenv::
+
+   virtualenv venv
+   source venv/bin/activate
+   pip install cubicweb[etwist] cubicweb-dev cubicweb-blog
+
 Then create and initialize your instance::
 
     cubicweb-ctl create blog myblog
@@ -31,7 +37,12 @@
 
 The `-D` option activates the debugging mode. Removing it will launch the instance
 as a daemon in the background, and ``cubicweb-ctl stop myblog`` will stop
-it in that case. 
+it in that case.
+
+.. Note::
+
+   If you get a traceback when going on the web interface make sure your
+   version of twisted is **inferior** to 17.
 
 
 About file system permissions
@@ -67,4 +78,3 @@
 You'll have to restart the instance after modification in one of those files.
 
 This is it. Your blog is functional and running. Visit http://localhost:8080 and enjoy it!
-