diff -r 1817f8946c22 -r faf279e33298 doc/book/pyramid/quickstart.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/pyramid/quickstart.rst Mon Sep 26 14:52:12 2016 +0200 @@ -0,0 +1,59 @@ +Quick start +=========== + +.. highlight:: bash + +Prerequites +----------- + +- Install everything (here with pip, possibly in a virtualenv):: + + pip install pyramid-cubicweb cubicweb-pyramid pyramid_debugtoolbar + +- Have a working Cubicweb instance, for example: + + + - Make sure CubicWeb is in user mode:: + + export CW_MODE=user + + - Create a CubicWeb instance, and install the 'pyramid' cube on it (see + :ref:`configenv` for more details on this step):: + + cubicweb-ctl create pyramid myinstance + +- Edit your ``~/etc/cubicweb.d/myinstance/all-in-one.conf`` and set values for + :confval:`pyramid-auth-secret` and :confval:`pyramid-session-secret`. + *required if cubicweb.pyramid.auth and pyramid_cubiweb.session get + included, which is the default* + +From CubicWeb +------------- + +- Start the instance with the :ref:`'pyramid' command ` + instead of 'start':: + + cubicweb-ctl pyramid --debug myinstance + +In a pyramid application +------------------------ + +- Create a pyramid application + +- Include cubicweb.pyramid: + + .. code-block:: python + + def includeme(config): + # ... + config.include('cubicweb.pyramid') + # ... + +- Configure the instance name (in the .ini file): + + .. code-block:: ini + + cubicweb.instance = myinstance + +- Configure the base-url and https-url in all-in-one.conf to match the ones + of the pyramid configuration (this is a temporary limitation).