.\" -*- 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 "llng-fastcgi-server 8"
.TH llng-fastcgi-server 8 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
llng\-fastcgi\-server \- FastCGI server used for providing LemonLDAP::NG services.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& # Start server listening to /run/llng.sock with 10 workers
\& llng\-fastcgi\-server \-u nobody \-g nobody \-s /run/llng.sock \-n 10
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
llng-fastcgi-server has been designed to provide LemonLDAP::NG services to Nginx
or DevOps Handler.
Portal, Manager and Handler will be compiled just-in-time. So this FastCGI
server can be used on every LemonLDAP::NG server even if it needs only some
parts (isolated handlers, portal,...).
.SH PARAMETERS
.IX Header "PARAMETERS"
Each parameter can be set by using options or environment variables.
.IP "\-\-pid \-p ($ENV{PID}):" 4
.IX Item "--pid -p ($ENV{PID}):"
pid file
.IP "\-\-user \-u ($ENV{USER}):" 4
.IX Item "--user -u ($ENV{USER}):"
user
.IP "\-\-group \-g ($ENV{GROUP}):" 4
.IX Item "--group -g ($ENV{GROUP}):"
group
.IP "\-\-proc \-n ($ENV{NPROC}):" 4
.IX Item "--proc -n ($ENV{NPROC}):"
Number of processus for FCGI
.IP "\-\-socket \-s ($ENV{SOCKET}):" 4
.IX Item "--socket -s ($ENV{SOCKET}):"
Unix socket
.IP "\-\-listen \-l ($ENV{LISTEN}):" 4
.IX Item "--listen -l ($ENV{LISTEN}):"
Listening address (HOST:PORT, :PORT, or PATH)
.IP "\-\-customFunctionsFile \-f ($ENV{CUSTOM_FUNCTIONS_FILE}):" 4
.IX Item "--customFunctionsFile -f ($ENV{CUSTOM_FUNCTIONS_FILE}):"
file to load for custom functions
.IP "\-\-engine \-e ($ENV{ENGINE}):" 4
.IX Item "--engine -e ($ENV{ENGINE}):"
Plack::Handler engine, default to FCGI (see below)
.IP \-\-plackOptions: 4
.IX Item "--plackOptions:"
To pass other options to the Plack handler. This multi-valued parameter must
have "key=value" values.
.Sp
See Plack::Handler::FCGI to find out list of available options for default FCGI engine
.SH ENGINES
.IX Header "ENGINES"
By default, llng-fastcgi-server uses FCGI (= Plack::Handler::FCGI).
Some other engines can be used:
.SS "FCGI (default)"
.IX Subsection "FCGI (default)"
It uses FCGI::ProcManager as manager. Other managers:
.IP FCGI::ProcManager::Dynamic 4
.IX Item "FCGI::ProcManager::Dynamic"
.Vb 2
\& llng\-fastcgi\-server \-u nobody \-g nobody \-s /run/llng.sock \-e FCGI \-n 10 \e
\& \-\-plackOptions manager=FCGI::ProcManager::Dynamic
.Ve
.SS "Other FCGI::ProcManager style engines"
.IX Subsection "Other FCGI::ProcManager style engines"
.IP FCGI::Engine 4
.IX Item "FCGI::Engine"
.SS "Event engines"
.IX Subsection "Event engines"
.PD 0
.IP AnyEvent::FCGI 4
.IX Item "AnyEvent::FCGI"
.IP FCGI::Async 4
.IX Item "FCGI::Async"
.IP FCGI::EV 4
.IX Item "FCGI::EV"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH AUTHORS
.IX Header "AUTHORS"
.IP "Clement Oudot, " 4
.IX Item "Clement Oudot, "
.PD 0
.IP "Xavier Guimard, " 4
.IX Item "Xavier Guimard, "
.PD
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use OW2 system to report bug or ask for features:
.SH DOWNLOAD
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "Copyright (C) 2008\-2016 by Xavier Guimard, " 4
.IX Item "Copyright (C) 2008-2016 by Xavier Guimard, "
.PD 0
.IP "Copyright (C) 2008\-2016 by Clément Oudot, " 4
.IX Item "Copyright (C) 2008-2016 by Clément Oudot, "
.PD
.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 .