author | David Douard <david.douard@logilab.fr> |
Tue, 23 Feb 2016 11:14:22 +0100 | |
changeset 11674 | 04dbef596243 |
parent 11632 | b05f361db666 |
child 11678 | a615997559a6 |
permissions | -rw-r--r-- |
11632 | 1 |
Summary |
2 |
------- |
|
11674
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
3 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
4 |
Add the 'pyramid' command to cubicweb-ctl". |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
5 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
6 |
This cube also add a ``CWSession`` entity type so that sessions can be |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
7 |
stored in the database, which allows to run a Cubicweb instance |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
8 |
without having to set up a session storage (like redis or memcache) |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
9 |
solution. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
10 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
11 |
However, for production systems, it is greatly advised to use such a |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
12 |
storage solution for the sessions. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
13 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
14 |
The handling of the sessions is made by pyramid (see the |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
15 |
`pyramid's documentation on sessions`_ for more details). |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
16 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
17 |
For example, to set up a redis based session storage, you need the |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
18 |
`pyramid-redis-session`_ package, then you must configure pyramid to |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
19 |
use this backend, by configuring the ``pyramid.ini`` file in the instance's |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
20 |
config directory (near the ``all-in-one.conf`` file): |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
21 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
22 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
23 |
.. code-block:: ini |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
24 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
25 |
[main] |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
26 |
cubicweb.defaults = no # we do not want to load the default cw session handling |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
27 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
28 |
cubicweb.auth.authtkt.session.secret = <secret1> |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
29 |
cubicweb.auth.authtkt.persistent.secret = <secret2> |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
30 |
cubicweb.auth.authtkt.session.secure = yes |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
31 |
cubicweb.auth.authtkt.persistent.secure = yes |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
32 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
33 |
redis.sessions.secret = <secret3> |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
34 |
redis.sessions.prefix = <my-app>: |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
35 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
36 |
redis.sessions.url = redis://localhost:6379/0 |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
37 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
38 |
pyramid.includes = |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
39 |
pyramid_redis_sessions |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
40 |
pyramid_cubicweb.auth |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
41 |
pyramid_cubicweb.login |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
42 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
43 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
44 |
See the documentation of `Pyramid Cubicweb`_ for more details. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
45 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
46 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
47 |
Secrets |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
48 |
~~~~~~~ |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
49 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
50 |
There are a number of secrets to configure in ``pyramid.ini``. They |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
51 |
should be different one from each other, as explained in `Pyramid's |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
52 |
documentation`_. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
53 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
54 |
For the record: |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
55 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
56 |
:cubicweb.session.secret: This secret is used to encrypt the session's |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
57 |
data ID (data themselved are stored in the backend, database or |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
58 |
redis) when using the integrated (``CWSession`` based) session data |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
59 |
storage. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
60 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
61 |
:redis.session.secret: This secret is used to encrypt the session's |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
62 |
data ID (data themselved are stored in the backend, database or |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
63 |
redis) when using redis as backend. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
64 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
65 |
:cubicweb.auth.authtkt.session.secret: This secret is used to encrypt |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
66 |
the authentication cookie. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
67 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
68 |
:cubicweb.auth.authtkt.persistent.secret: This secret is used to |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
69 |
encrypt the persistent authentication cookie. |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
70 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
71 |
|
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
72 |
.. _`Pyramid Cubicweb`: http://pyramid-cubicweb.readthedocs.org/ |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
73 |
.. _`pyramid's documentation on sessions`: http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/sessions.html |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
74 |
.. _`pyramid-redis-session`: http://pyramid-redis-sessions.readthedocs.org/en/latest/index.html |
04dbef596243
[doc] add a bit more infos in the README
David Douard <david.douard@logilab.fr>
parents:
11632
diff
changeset
|
75 |
.. _`Pyramid's documentation`: http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/security.html#admonishment-against-secret-sharing |