Update doc for custom functions (#2706)
This commit is contained in:
parent
85938271fe
commit
c84e3981c1
|
@ -51,81 +51,28 @@ as you want, for example ``SSOExtensions.pm``:
|
||||||
Import custom functions in LemonLDAP::NG
|
Import custom functions in LemonLDAP::NG
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
Load relevant code in handler server
|
LemonLDAP::NG Configuration
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
New method
|
Edit ``lemonldap-ng.ini`` to load the Perl module(s)
|
||||||
^^^^^^^^^^
|
|
||||||
|
|
||||||
Just declare files or Perl module that must be loaded:
|
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
[all]
|
[all]
|
||||||
require = /path/to/functions.pl, /path/to/SSOExtensions.pm
|
require = /path/to/SSOExtensions.pm
|
||||||
# OR
|
|
||||||
require = SSOExtensions::function1, SSOExtensions::function2
|
|
||||||
; Prevent Portal to crash if Perl module is not found
|
; Prevent Portal to crash if Perl module is not found
|
||||||
;requireDontDie = 1
|
;requireDontDie = 1
|
||||||
|
|
||||||
Old method
|
|
||||||
^^^^^^^^^^
|
|
||||||
|
|
||||||
|
|
||||||
.. danger::
|
|
||||||
|
|
||||||
This method is available but unusable by Portal under
|
|
||||||
Apache. So if your rule may be used by the menu, use the new
|
|
||||||
method.
|
|
||||||
|
|
||||||
Apache
|
|
||||||
''''''
|
|
||||||
|
|
||||||
Your module has to be loaded by Apache (for example after Handler load):
|
|
||||||
|
|
||||||
.. code-block:: apache
|
|
||||||
|
|
||||||
# Perl environment
|
|
||||||
PerlRequire Lemonldap::NG::Handler
|
|
||||||
PerlRequire /path/to/SSOExtensions.pm
|
|
||||||
PerlOptions +GlobalRequest
|
|
||||||
|
|
||||||
FastCGI server (Nginx)
|
|
||||||
''''''''''''''''''''''
|
|
||||||
|
|
||||||
You've just to incicate to :doc:`LLNG FastCGI server<fastcgiserver>` the
|
|
||||||
file to read using either ``-f`` option or ``CUSTOM_FUNCTIONS_FILE``
|
|
||||||
environment variable. Using packages, you just have to modify your
|
|
||||||
``/etc/default/llng-fastcgi-server`` (or
|
|
||||||
``/etc/default/lemonldap-ng-fastcgi-server``) file:
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
# Number of process (default: 7)
|
|
||||||
#NPROC = 7
|
|
||||||
|
|
||||||
# Unix socket to listen to
|
|
||||||
SOCKET=/var/run/llng-fastcgi-server/llng-fastcgi.sock
|
|
||||||
|
|
||||||
# Pid file
|
|
||||||
PID=/var/run/llng-fastcgi-server/llng-fastcgi-server.pid
|
|
||||||
|
|
||||||
# User and GROUP
|
|
||||||
USER=www-data
|
|
||||||
GROUP=www-data
|
|
||||||
|
|
||||||
# Custom functions file
|
|
||||||
CUSTOM_FUNCTIONS_FILE=/path/to/SSOExtensions.pm
|
|
||||||
|
|
||||||
Declare custom functions
|
Declare custom functions
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Go in Manager, ``General Parameters`` » ``Advanced Parameters`` »
|
Go in Manager, ``General Parameters`` » ``Advanced Parameters`` »
|
||||||
``Custom functions`` and set:
|
``Custom functions`` and declare your function names, separated by a space:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
SSOExtensions::function1, SSOExtensions::function2
|
SSOExtensions::function1 SSOExtensions::function2
|
||||||
|
|
||||||
|
|
||||||
.. attention::
|
.. attention::
|
||||||
|
@ -133,13 +80,13 @@ Go in Manager, ``General Parameters`` » ``Advanced Parameters`` »
|
||||||
If your function is not compliant with
|
If your function is not compliant with
|
||||||
:doc:`Safe jail<safejail>`, you will need to disable the jail.
|
:doc:`Safe jail<safejail>`, you will need to disable the jail.
|
||||||
|
|
||||||
Use it
|
Usage
|
||||||
------
|
-----
|
||||||
|
|
||||||
You can now use your function in a macro, an header or an access rule,
|
You can now use your function in a macro, an header or an access rule,
|
||||||
for example:
|
for example:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
SSOExtensions::function1( $uid, $ENV{REMOTE_ADDR} )
|
function1( $uid, $ENV{REMOTE_ADDR} )
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user