Quick start¶

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 Set-up of a CubicWeb environment 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 pyramid-auth-secret and pyramid-session-secret. required if cubicweb.pyramid.auth and pyramid_cubiweb.session get included, which is the default

Start the instance with the ‘pyramid’ command instead of ‘start’:
```
cubicweb-ctl pyramid --debug myinstance
```

Include cubicweb.pyramid:

def includeme(config):
    # ...
    config.include('cubicweb.pyramid')
    # ...

Configure the instance name (in the .ini file):
```
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).