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

51 lines
1.2 KiB
ReStructuredText
Raw Normal View History

2020-05-14 23:29:41 +02:00
Custom authentication modules
=============================
============== ===== ========
Authentication Users Password
============== ===== ========
✔ ✔ ✔
============== ===== ========
Presentation
------------
This artifact allows one to define its own modules (authentication, user
database, password or register database).
2020-05-18 09:56:39 +02:00
.. tip::
2020-05-14 23:29:41 +02:00
The developer documentation is available in Portal manpages.
2020-05-18 09:56:39 +02:00
See Auth.pod and UserDB.pod
2020-05-14 23:29:41 +02:00
Configuration
-------------
In Manager, go in ``General Parameters`` > ``Authentication modules``
and choose 'Custom module'.
Then, you just have to define class names of your custom modules in
"Custom module names". Custom parameters can be set in "Additional
parameters". Full path must be specify.
You can define your own customAuth module icon. Icon must be in
site/htdocs/static/common/modules/icon.png
2020-05-18 09:56:39 +02:00
.. tip::
2020-05-14 23:29:41 +02:00
::Auth::My::Dev.pm means Lemonldap::NG::Portal::Auth::My::Dev
2020-05-21 15:13:24 +02:00
.. attention::
2020-05-14 23:29:41 +02:00
Be careful. Don' t use an already attributed name in
2020-05-18 09:56:39 +02:00
configuration.
These parameters are available in your plugins using
``$self->conf->{customAddParams}->{<customName>}``.
2020-05-14 23:29:41 +02:00
Read portal manpages to see how to write these plugins.