Commit b1881672 authored by Yadd's avatar Yadd
Browse files

More POD

parent 280a1265
......@@ -50,11 +50,12 @@ Homepage: http://lemonldap-ng.org/
Package: lemonldap-ng
Architecture: all
Provides: saml-identity-provider, saml-service-provider
Depends: ${misc:Depends},
liblemonldap-ng-handler-perl (= ${binary:Version}),
liblemonldap-ng-manager-perl (= ${binary:Version}),
liblemonldap-ng-portal-perl (= ${binary:Version})
Provides: saml-identity-provider,
saml-service-provider
Description: OpenID, CAS and SAML compatible Web-SSO system
Lemonldap::NG is a complete Web-SSO system that can run with reverse-proxies
or directly on application Apache servers. It can be used in conjunction with
......
......@@ -96,7 +96,48 @@ system.
Lemonldap::NG::Manager provides a web interface to manage Lemonldap::NG Web-SSO
system.
This interface uses L<Plack> to be compatible with CGI, FastCGI,...
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 given in source tree.
Lemonldap::NG Manager uses L<Plack> to be compatible with CGI, FastCGI,... It
inherits of L<Lemonldap::NG::Handler::PSGI>
=head1 ORGANIZATION
Lemonldap::NG Manager contains 4 parts:
=over
=item Configuration management: see L<Lemonldap::NG::Manager::Conf>;
=item Session explorer: see L<Lemonldap::NG::Manager::Sessions>;
=item Notification explorer: see L<Lemonldap::NG::Manager::Notifications>;
=item Some files uses to generate static files: see bellow.
=back
=head2 Generation of static files
The `scripts/jsongenerator.pl` file uses Lemonldap::NG::Manager::Attributes,
Lemonldap::NG::Manager::Tree and Lemonldap::NG::Manager::CTrees to generate
=over
=item `site/static/struct.json`: the main file that contains the tree view;
=item `site/static/js/conftree.js`: generates sub tree for virtualhosts and
SAML and OpenID-Connect partners;
=item `Lemonldap::NG::Manager::Constants`: constants used by all Perl manager
components;
=item `Lemonldap::NG::Common::Conf::DefaultValues`: constants used to read
configuration.
=back
=head1 PARAMETERS
......@@ -105,9 +146,40 @@ can specify where your lemonldap-ng.ini file is:
Lemonldap::NG::Manager->run( { confFile => '/path/to/lemonldap-ng.ini' } );
=head2 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 $opts hash ref passed as argument to run() or new()).
[manager]
;protection: choose one of none, authenticate, manager as explain in
; Lemonldap::NG::Handler::PSGI doc.
protection = manager
;enabledModules: Modules to display. Default to `conf, sessions, notifications`
enabledModules = conf, sessions, notifications
;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: the path to the directory containing HTML templates
; See Lemonldap::NG::Common::PSGI doc for more
templateDir = /usr/share/lemonldap-ng/manager/
=head1 SEE ALSO
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Portal>, L<Plack>, L<PSGI>,
L<Lemonldap::NG::Manager::Conf>, L<Lemonldap::NG::Manager::Sessions>,
L<Lemonldap::NG::Manager::Notifications>
L<http://lemonldap-ng.org/>
=head1 AUTHORS
......
......@@ -826,4 +826,107 @@ sub applyConf {
}
1;
__END__
=head1 NAME
=encoding utf8
Lemonldap::NG::Manager::Conf - Configuration management part of
L<Lemonldap::NG::Manager>.
=head1 SYNOPSIS
See L<Lemonldap::NG::Manager>.
=head1 DESCRIPTION
Lemonldap::NG::Manager provides a web interface to manage Lemonldap::NG Web-SSO
system.
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 given in source tree.
Lemonldap::NG Manager::Conf provides the configuration management part.
=head1 ORGANIZATION
Lemonldap::NG::Manager configuration is managed by 2 files:
=over
=item This file to display configuration metadatas and keys content, and to
save new configuration,
=item L<Lemonldap::NG::Manager::ConfParser> used to check proposed configuration.
=back
=head1 OPERATION
The first Ajax request given by the manager web interface is generaly
`/confs/latest`, Lemonldap::NG::Manager::Conf returns the configuration
metadatas (author, data, log,...). Then for each key read by the user, web
interface launch an Ajax request to get the value.
At the end, when modifications are saved, a POST request is done to `/confs`.
Then Lemonldap::NG::Manager::Conf calls L<Lemonldap::NG::Manager::ConfParser>
to verify new configuration. If good, it tries to store it. Then it calls
applyConf() that tries to call other servers to explain them that configuration
has changed. Then it returns all errors, warnings in a JSON object that is
displayed by web interface.
=head1 SEE ALSO
L<Lemonldap::NG::Manager::ConfParser>, L<Lemonldap::NG::Manager>,
L<http://lemonldap-ng.org/>
=head1 AUTHORS
=over
=item Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
=item François-Xavier Deltombe, E<lt>fxdeltombe@gmail.com.E<gt>
=item Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Thomas Chemineau, E<lt>thomas.chemineau@gmail.comE<gt>
=back
=head1 BUG REPORT
Use OW2 system to report bug or ask for features:
L<http://jira.ow2.org>
=head1 DOWNLOAD
Lemonldap::NG is available at
L<http://forge.objectweb.org/project/showfiles.php?group_id=274>
=head1 COPYRIGHT AND LICENSE
=over
=item Copyright (C) 2015 by Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Copyright (C) 2015 by Clément Oudot, E<lt>clem.oudot@gmail.comE<gt>
=back
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.
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.
You should have received a copy of the GNU General Public License
along with this program. If not, see L<http://www.gnu.org/licenses/>.
=cut
......@@ -340,4 +340,85 @@ sub deleteDoneNotification {
}
1;
__END__
=head1 NAME
=encoding utf8
Lemonldap::NG::Manager::Notifications - Notifications explorer component of
L<Lemonldap::NG::Manager>.
=head1 SYNOPSIS
See L<Lemonldap::NG::Manager>.
=head1 DESCRIPTION
Lemonldap::NG::Manager provides a web interface to manage Lemonldap::NG Web-SSO
system.
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 given in source tree.
Lemonldap::NG Manager::Notifications provides the notifications explorer part.
=head1 ORGANIZATION
Lemonldap::NG Manager::Notifications is the only one module used to explore
notifications. The javascript part is in `site/static/js/notifications.js`
file.
=head1 SEE ALSO
L<Lemonldap::NG::Manager>, L<http://lemonldap-ng.org/>
=head1 AUTHORS
=over
=item Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
=item François-Xavier Deltombe, E<lt>fxdeltombe@gmail.com.E<gt>
=item Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Thomas Chemineau, E<lt>thomas.chemineau@gmail.comE<gt>
=back
=head1 BUG REPORT
Use OW2 system to report bug or ask for features:
L<http://jira.ow2.org>
=head1 DOWNLOAD
Lemonldap::NG is available at
L<http://forge.objectweb.org/project/showfiles.php?group_id=274>
=head1 COPYRIGHT AND LICENSE
=over
=item Copyright (C) 2015 by Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Copyright (C) 2015 by Clément Oudot, E<lt>clem.oudot@gmail.comE<gt>
=back
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.
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.
You should have received a copy of the GNU General Public License
along with this program. If not, see L<http://www.gnu.org/licenses/>.
=cut
......@@ -381,3 +381,84 @@ sub getMod {
}
1;
__END__
=head1 NAME
=encoding utf8
Lemonldap::NG::Manager::Sessions - Sessions explorer component of
L<Lemonldap::NG::Manager>.
=head1 SYNOPSIS
See L<Lemonldap::NG::Manager>.
=head1 DESCRIPTION
Lemonldap::NG::Manager provides a web interface to manage Lemonldap::NG Web-SSO
system.
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 given in source tree.
Lemonldap::NG Manager::Sessions provides the sessions explorer part.
=head1 ORGANIZATION
Lemonldap::NG Manager::Sessions is the only one module used to explore sessions.
The javascript part is in `site/static/js/sessions.js` file.
=head1 SEE ALSO
L<Lemonldap::NG::Manager>, L<http://lemonldap-ng.org/>
=head1 AUTHORS
=over
=item Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
=item François-Xavier Deltombe, E<lt>fxdeltombe@gmail.com.E<gt>
=item Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Thomas Chemineau, E<lt>thomas.chemineau@gmail.comE<gt>
=back
=head1 BUG REPORT
Use OW2 system to report bug or ask for features:
L<http://jira.ow2.org>
=head1 DOWNLOAD
Lemonldap::NG is available at
L<http://forge.objectweb.org/project/showfiles.php?group_id=274>
=head1 COPYRIGHT AND LICENSE
=over
=item Copyright (C) 2015 by Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Copyright (C) 2015 by Clément Oudot, E<lt>clem.oudot@gmail.comE<gt>
=back
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.
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.
You should have received a copy of the GNU General Public License
along with this program. If not, see L<http://www.gnu.org/licenses/>.
=cut
......@@ -37,7 +37,7 @@
<div class="vresizer" resizer="horizontal" resizer-top="#top" resizer-bottom="#bottom"></div>
<div class="panel panel-default">
<div class="panel-body">
<iframe width="100%" height="100%" ng-src="{{translate('__helpPath__')+'pages/documentation/current/'+helpUrl}}" frameborder="0"></iframe>
<iframe id="helpframe" width="100%" height="100%" ng-src="{{translate('__helpPath__')+'pages/documentation/current/'+helpUrl}}" frameborder="0"></iframe>
</div>
</div>
</div>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment