.. highlight:: bash

Prerequites

-----------

-   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

    *required if pyramid_cubicweb.auth and pyramid_cubiweb.session get

    included, which is the default*

From CubicWeb

-------------

-   Create a pyramid application

-   Include pyramid_cubicweb:

    .. code-block:: python

        def includeme(config):

            # ...

            config.include('pyramid_cubicweb')

            # ...

-   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).