lemonldap-ng/doc/sources/admin/browseablesessionbackend.rst

60 lines
2.0 KiB
ReStructuredText
Raw Normal View History

2020-05-14 23:29:41 +02:00
Browseable session backend
==========================
Presentation
------------
Browseable session backend
2020-05-18 09:56:39 +02:00
(`Apache::Session::Browseable <https://metacpan.org/pod/Apache::Session::Browseable>`__)
2020-05-14 23:29:41 +02:00
works exactly like Apache::Session::\* corresponding module but add
2020-09-23 07:51:35 +02:00
index that increase the speed of some operations. It is recommended in production deployments.
2020-05-14 23:29:41 +02:00
2020-05-18 09:56:39 +02:00
.. note::
2020-05-14 23:29:41 +02:00
Without index, LL::NG will have to retrieve all sessions stored in
2020-09-23 07:51:35 +02:00
backend and deserialize then filter each of them.
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
The following table list fields to index for each session type:
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
.. _fieldstoindex:
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
List of fields to index by session type
---------------------------------------
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
========================== ======================================================================
Session Type Fields to index
========================== ======================================================================
Sessions (global) \_whatToTrace \_session_kind \_utime ipAddr \_httpSessionType user
Persistent sessions \_session\_kind \_httpSessionType \_session\_uid ipAddr \_whatToTrace
CAS sessions \_cas\_id pgtIou
SAML sessions \_session_kind \_utime \_saml_id ProxyID \_nameID \_assert_id \_art_id
OpenID Connect sessions \_session_kind \_utime
========================== ======================================================================
2020-05-14 23:29:41 +02:00
2020-05-18 09:56:39 +02:00
.. note::
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
If you have configured LemonLDAP::NG to use something other than
`_whatToTrace` as the main session identifier, you must replace
`_whatToTrace` with the new session field in the previous list
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
See Apache::Session::Browseable man page to see how use indexes.
2020-05-14 23:29:41 +02:00
2020-05-18 09:56:39 +02:00
.. tip::
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
It is advised to use separate session backends for standard sessions, SAML
sessions and CAS sessions, in order to avoid unused indexes.
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
Available backends
------------------
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
.. toctree::
:maxdepth: 1
2020-05-14 23:29:41 +02:00
2020-09-23 07:51:35 +02:00
PgJSON Backend (recommended) <pgjsonsessionbackend>
browseablemysqlsessionbackend
browseableldapsessionbackend
nosqlsessionbackend