lemonldap-ng/doc/sources/admin/devopshandler.rst
Christophe Maudoux 91d63f5a87 Doc typos
2022-01-02 22:55:55 +01:00

40 lines
1.1 KiB
ReStructuredText

DevOps Handler
==============
This Handler is designed to retrieve vhost configuration from the website
itself, not from LL:NG configuration. Rules and headers are set in a
**rules.json** file stored at the website root directory (ie
``http://website/rules.json``). This file looks like:
.. code-block:: json
{
"rules": {
"^/admin": "$uid eq 'admin'",
"default": "accept"
},
"headers": {
"Auth-User": "$uid"
}
}
If this file is not found, the default rule "accept" is applied and just
"Auth-User" header is sent (Auth-User => $uid).
No specific configuration is required except that:
- you have to choose this specific handler (directly by using
``VHOSTTYPE`` environment variable or in VHost options)
- you can set the loopback URL needed by the DevOps handler to get
``/rules.json`` or use ``RULES_URL`` parameter to set JSON file path
(see :doc:`SSO as a Service<ssoaas>`). Default to
``http://127.0.0.1:<server-port>``
.. attention::
Note that DevOps handler will not compile
rules.json if :doc:`Safe Jail<safejail>` is not enabled.
See :doc:`SSO as a Service<ssoaas>` for more.