.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Lemonldap::NG::Manager 3pm"
.TH Lemonldap::NG::Manager 3pm 2024-02-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lemonldap::NG::Manager \- Perl extension for managing Lemonldap::NG Web\-SSO
system.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Use any of Plack launcher. Example:
.PP
.Vb 1
\& #!/usr/bin/env plackup
\&
\& use Lemonldap::NG::Manager;
\&
\& # This must be the last instruction ! See PSGI for more
\& Lemonldap::NG::Manager\->run($opts);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lemonldap::NG::Manager provides a web interface to manage Lemonldap::NG Web-SSO
system.
.PP
The Perl part of Lemonldap::NG::Manager is the REST server. Web interface is
written in Javascript, using AngularJS framework and can be found in `site`
directory. The REST API is described in REST\-API.md file provided in source tree.
.PP
Lemonldap::NG Manager uses Plack to be CGI, FastCGI and so on compatible.
It inherits of Lemonldap::NG::Handler::PSGI::Router
.SH ORGANIZATION
.IX Header "ORGANIZATION"
Lemonldap::NG Manager contains 6 parts:
.IP "Configuration management" 4
.IX Item "Configuration management"
.PD 0
.IP "Session explorer" 4
.IX Item "Session explorer"
.IP "Notification explorer" 4
.IX Item "Notification explorer"
.IP "Second Factors manager" 4
.IX Item "Second Factors manager"
.IP "Configuration builder (see Lemonldap::NG::Manager::Build" 4
.IX Item "Configuration builder (see Lemonldap::NG::Manager::Build"
.IP "Command line interface (see Lemonldap::NG::Manager::Cli" 4
.IX Item "Command line interface (see Lemonldap::NG::Manager::Cli"
.PD
.SS "Static files generation"
.IX Subsection "Static files generation"
`scripts/jsongenerator.pl` file uses Lemonldap::NG::Manager::Build::Attributes,
Lemonldap::NG::Manager::Build::Tree and Lemonldap::NG::Manager::Build::CTrees to generate
.IP `site/htdocs/static/struct.json`: 4
.IX Item "`site/htdocs/static/struct.json`:"
main file containing the tree view;
.IP `site/htdocs/static/js/conftree.js`: 4
.IX Item "`site/htdocs/static/js/conftree.js`:"
generates Virtualhosts, SAML and OpenID-Connect partners sub-trees;
.IP `Lemonldap::NG::Common::Conf::ReConstants`: 4
.IX Item "`Lemonldap::NG::Common::Conf::ReConstants`:"
constants used by all Perl manager components;
.IP `Lemonldap::NG::Common::Conf::DefaultValues`: 4
.IX Item "`Lemonldap::NG::Common::Conf::DefaultValues`:"
constants used to read configuration.
.SH PARAMETERS
.IX Header "PARAMETERS"
You can use a hash ref to override any LemonLDAP::NG parameter. Currently, you
can specify where your lemonldap\-ng.ini file is:
.PP
.Vb 1
\& Lemonldap::NG::Manager\->run( { confFile => \*(Aq/path/to/lemonldap\-ng.ini\*(Aq } );
.Ve
.SS "lemonldap\-ng.ini parameters"
.IX Subsection "lemonldap-ng.ini parameters"
You can override any configuration parameter in lemonldap\-ng.ini, but some are
required and can't be set to global configuration (as any Lemonldap::NG module,
you can also fix them in \f(CW$opts\fR hash ref passed as argument to \fBrun()\fR or \fBnew()\fR).
.PP
.Vb 4
\& [manager]
\& ;protection: choose one of none, authenticate, manager as explain in
\& ; Lemonldap::NG::Handler::PSGI::Router doc.
\& protection = manager
\&
\& ;enabledModules: Modules to display. Default to \`conf, sessions, notifications, 2ndFA\`
\& enabledModules = conf, sessions, notifications, 2ndFA
\&
\& ;logLevel: choose one of error, warn, notice, info, debug
\& ; See Lemonldap::NG::Common::PSGI doc for more
\& logLevel = notice
\&
\& ;staticPrefix: set here the URI path to static content
\& ; See Lemonldap::NG::Common::PSGI doc for more
\& staticPrefix = static/
\&
\& ;languages: Available interface languages
\& languages = en, fr
\&
\& ;templateDir: path to the directory containing HTML templates
\& ; See Lemonldap::NG::Common::PSGI doc for more
\& templateDir = /usr/share/lemonldap\-ng/manager/
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH AUTHORS
.IX Header "AUTHORS"
.IP "LemonLDAP::NG team " 4
.IX Item "LemonLDAP::NG team "
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use OW2 system to report bug or ask for features:
.PP
Note that if you want to post a ticket for a conf upload problem, please
see Lemonldap::NG::Manager::Conf::Parser before.
.SH DOWNLOAD
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
See COPYING file for details.
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program. If not, see .